Added: lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Search/Span.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Search/Span.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Search/Span.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Search/Span.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,141 @@ +Title: Lucy::Search::Span â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Search::Span - An offset, +a length, +and a weight.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $combined_length = $upper_span->get_length + + ( $upper_span->get_offset - $lower_span->get_offset ); +my $combined_span = Lucy::Search::Span->new( + offset => $lower_span->get_offset, + length => $combined_length, +); +...</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Span objects store information about a span across an array of… something. +The unit is context-dependent.</p> + +<p>Text is one possibility, +in which case offset and length might be measured in Unicode code points. +However, +the Span could also refer to a span within an array of tokens, +for example – in which case the start and offset might be measured in token positions.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $span = Lucy::Search::Span->new( + offset => 75, # required + length => 7, # required + weight => 1.0, # default 0.0 +);</pre> + +<p>Create a new Span.</p> + +<ul> +<li><b>offset</b> - Integer offset, +unit is context-dependent.</li> + +<li><b>length</b> - Integer length, +unit is context-dependent.</li> + +<li><b>weight</b> - A floating point weight.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_offset" +>get_offset</a></h3> + +<pre>my $int = $span->get_offset();</pre> + +<p>Accessor for <code>offset</code> attribute.</p> + +<h3><a class='u' +name="set_offset" +>set_offset</a></h3> + +<pre>$span->set_offset($offset);</pre> + +<p>Setter for <code>offset</code> attribute.</p> + +<h3><a class='u' +name="get_length" +>get_length</a></h3> + +<pre>my $int = $span->get_length();</pre> + +<p>Accessor for <code>length</code> attribute.</p> + +<h3><a class='u' +name="set_length" +>set_length</a></h3> + +<pre>$span->set_length($length);</pre> + +<p>Setter for <code>length</code> attribute.</p> + +<h3><a class='u' +name="get_weight" +>get_weight</a></h3> + +<pre>my $float = $span->get_weight();</pre> + +<p>Accessor for <code>weight</code> attribute.</p> + +<h3><a class='u' +name="set_weight" +>set_weight</a></h3> + +<pre>$span->set_weight($weight);</pre> + +<p>Setter for <code>weight</code> attribute.</p> + +<h3><a class='u' +name="compare_to" +>compare_to</a></h3> + +<pre>my $int = $span->compare_to($other);</pre> + +<p>Indicate whether one object is less than, +equal to, +or greater than another.</p> + +<ul> +<li><b>other</b> - Another Obj.</li> +</ul> + +<p>Returns: 0 if the objects are equal, +a negative number if <code>self</code> is less than <code>other</code>, +and a positive number if <code>self</code> is greater than <code>other</code>.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::Span isa Clownfish::Obj.</p> + +</div>
Added: lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Search/TermQuery.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Search/TermQuery.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Search/TermQuery.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Search/TermQuery.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,100 @@ +Title: Lucy::Search::TermQuery â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Search::TermQuery - Query which matches individual terms.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $term_query = Lucy::Search::TermQuery->new( + field => 'content', + term => 'foo', +); +my $hits = $searcher->hits( query => $term_query );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>TermQuery is a subclass of <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Query</a> for matching individual terms in a specific field.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $term_query = Lucy::Search::TermQuery->new( + field => 'content', # required + term => 'foo', # required +);</pre> + +<p>Create a new TermQuery.</p> + +<ul> +<li><b>field</b> - Field name.</li> + +<li><b>term</b> - Term text.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_field" +>get_field</a></h3> + +<pre>my $string = $term_query->get_field();</pre> + +<p>Accessor for object’s <code>field</code> member.</p> + +<h3><a class='u' +name="get_term" +>get_term</a></h3> + +<pre>my $obj = $term_query->get_term();</pre> + +<p>Accessor for object’s <code>term</code> member.</p> + +<h3><a class='u' +name="make_compiler" +>make_compiler</a></h3> + +<pre>my $compiler = $term_query->make_compiler( + searcher => $searcher # required + boost => $boost # required + subordinate => $subordinate # default: false +);</pre> + +<p>Abstract factory method returning a Compiler derived from this Query.</p> + +<ul> +<li><b>searcher</b> - A Searcher.</li> + +<li><b>boost</b> - A scoring multiplier.</li> + +<li><b>subordinate</b> - 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#normalize" class="podlinkpod" +>normalize()</a> on the newly minted Compiler object before returning it.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::TermQuery isa <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</a> isa Clownfish::Obj.</p> + +</div> Copied: lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Simple.mdtext (from r1762634, lucy/site/trunk/content/docs/perl/Lucy/Simple.mdtext) URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Simple.mdtext?p2=lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Simple.mdtext&p1=lucy/site/trunk/content/docs/perl/Lucy/Simple.mdtext&r1=1762634&r2=1762636&rev=1762636&view=diff ============================================================================== (empty) Added: lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/FSFolder.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/FSFolder.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/FSFolder.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/FSFolder.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,55 @@ +Title: Lucy::Store::FSFolder â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::FSFolder - File System implementation of Folder.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $folder = Lucy::Store::FSFolder->new( + path => '/path/to/folder', +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Implementation of <a href="../../Lucy/Store/Folder.html" class="podlinkpod" +>Folder</a> using a single file system directory and multiple files.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $folder = Lucy::Store::FSFolder->new( + path => '/path/to/folder', +);</pre> + +<p>Create a new Folder.</p> + +<ul> +<li><b>path</b> - 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.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::FSFolder isa <a href="../../Lucy/Store/Folder.html" class="podlinkpod" +>Lucy::Store::Folder</a> isa Clownfish::Obj.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/Folder.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/Folder.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/Folder.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/Folder.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,39 @@ +Title: Lucy::Store::Folder â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::Folder - Abstract class representing a directory.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre># Abstract base class.</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<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" class="podlinkpod" +>FSFolder</a>, +represents a directory on the file system holding a collection of files.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::Folder isa Clownfish::Obj.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/Lock.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/Lock.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/Lock.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/Lock.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,155 @@ +Title: Lucy::Store::Lock â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::Lock - Abstract class representing an interprocess mutex lock.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $lock = $lock_factory->make_lock( + name => 'write', + timeout => 5000, +); +$lock->obtain or die "can't get lock for " . $lock->get_name; +do_stuff(); +$lock->release;</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<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> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $lock = Lucy::Store::Lock->new( + name => 'commit', # required + folder => $folder, # required + host => $hostname, # required + timeout => 5000, # default: 0 + interval => 1000, # default: 100 +);</pre> + +<p>Abstract constructor.</p> + +<ul> +<li><b>folder</b> - A Folder.</li> + +<li><b>name</b> - String identifying the resource to be locked, +which must consist solely of characters matching [-_.A-Za-z0-9].</li> + +<li><b>host</b> - A unique per-machine identifier.</li> + +<li><b>timeout</b> - Time in milliseconds to keep retrying before abandoning the attempt to <a href="#obtain" class="podlinkpod" +>obtain()</a> a lock.</li> + +<li><b>interval</b> - Time in milliseconds between retries.</li> +</ul> + +<h2><a class='u' +name="ABSTRACT_METHODS" +>ABSTRACT METHODS</a></h2> + +<h3><a class='u' +name="shared" +>shared</a></h3> + +<pre>my $bool = $lock->shared();</pre> + +<p>Returns true if the Lock is shared, +false if the Lock is exclusive.</p> + +<h3><a class='u' +name="request" +>request</a></h3> + +<pre>my $bool = $lock->request();</pre> + +<p>Make one attempt to acquire the lock.</p> + +<p>The semantics of <a href="#request" class="podlinkpod" +>request()</a> differ depending on whether <a href="#shared" class="podlinkpod" +>shared()</a> returns true. +If the Lock is <a href="#shared" class="podlinkpod" +>shared()</a>, +then <a href="#request" class="podlinkpod" +>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="#shared" class="podlinkpod" +>shared()</a> – i.e. +it’s an exclusive (write) lock – then other locks should cause <a href="#request" class="podlinkpod" +>request()</a> to fail.</p> + +<p>Returns: true on success, +false on failure (sets the global error object returned by Clownfish->error).</p> + +<h3><a class='u' +name="release" +>release</a></h3> + +<pre>$lock->release();</pre> + +<p>Release the lock.</p> + +<h3><a class='u' +name="is_locked" +>is_locked</a></h3> + +<pre>my $bool = $lock->is_locked();</pre> + +<p>Indicate whether the resource identified by this lock’s name is currently locked.</p> + +<p>Returns: true if the resource is locked, +false otherwise.</p> + +<h3><a class='u' +name="clear_stale" +>clear_stale</a></h3> + +<pre>$lock->clear_stale();</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> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="obtain" +>obtain</a></h3> + +<pre>my $bool = $lock->obtain();</pre> + +<p>Call <a href="#request" class="podlinkpod" +>request()</a> once per <code>interval</code> until <a href="#request" class="podlinkpod" +>request()</a> returns success or the <code>timeout</code> has been reached.</p> + +<p>Returns: true on success, +false on failure (sets the global error object returned by Clownfish->error).</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::Lock isa Clownfish::Obj.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/LockErr.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/LockErr.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/LockErr.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/LockErr.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,43 @@ +Title: Lucy::Store::LockErr â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::LockErr - Lock exception.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>while (1) { + my $bg_merger = eval { + Lucy::Index::BackgroundMerger->new( index => $index ); + }; + if ( blessed($@) and $@->isa("Lucy::Store::LockErr") ) { + warn "Retrying...\n"; + } + elsif (!$bg_merger) { + # Re-throw. + die "Failed to open BackgroundMerger: $@"; + } + ... +}</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>LockErr is a subclass of <a href="../../Clownfish/Err.html" class="podlinkpod" +>Err</a> which indicates that a file locking problem occurred.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::LockErr isa Clownfish::Err isa Clownfish::Obj.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/LockFactory.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/LockFactory.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/LockFactory.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/LockFactory.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,120 @@ +Title: Lucy::Store::LockFactory â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::LockFactory - Create Locks.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>use Sys::Hostname qw( hostname ); +my $hostname = hostname() or die "Can't get unique hostname"; +my $folder = Lucy::Store::FSFolder->new( + path => '/path/to/index', +); +my $lock_factory = Lucy::Store::LockFactory->new( + folder => $folder, + host => $hostname, +); +my $write_lock = $lock_factory->make_lock( + name => 'write', + timeout => 5000, + interval => 100, +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<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> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $lock_factory = Lucy::Store::LockFactory->new( + folder => $folder, # required + host => $hostname, # required +);</pre> + +<p>Create a new LockFactory.</p> + +<ul> +<li><b>folder</b> - A <a href="../../Lucy/Store/Folder.html" class="podlinkpod" +>Folder</a>.</li> + +<li><b>host</b> - An identifier which should be unique per-machine.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="make_lock" +>make_lock</a></h3> + +<pre>my $lock = $lock_factory->make_lock( + name => $name # required + timeout => $timeout # default: 0 + interval => $interval # default: 100 +);</pre> + +<p>Return a Lock object, +which, +once <a href="../../Lucy/Store/Lock.html#obtain" class="podlinkpod" +>obtain()</a> returns successfully, +maintains an exclusive lock on a resource.</p> + +<ul> +<li><b>name</b> - A file-system-friendly id which identifies the resource to be locked.</li> + +<li><b>timeout</b> - Time in milliseconds to keep retrying before abandoning the attempt to <a href="../../Lucy/Store/Lock.html#obtain" class="podlinkpod" +>obtain()</a> a lock.</li> + +<li><b>interval</b> - Time in milliseconds between retries.</li> +</ul> + +<h3><a class='u' +name="make_shared_lock" +>make_shared_lock</a></h3> + +<pre>my $lock = $lock_factory->make_shared_lock( + name => $name # required + timeout => $timeout # default: 0 + interval => $interval # default: 100 +);</pre> + +<p>Return a Lock object for which <a href="../../Lucy/Store/Lock.html#shared" class="podlinkpod" +>shared()</a> returns true, +and which maintains a non-exclusive lock on a resource once <a href="../../Lucy/Store/Lock.html#obtain" class="podlinkpod" +>obtain()</a> returns success.</p> + +<ul> +<li><b>name</b> - A file-system-friendly id which identifies the resource to be locked.</li> + +<li><b>timeout</b> - Time in milliseconds to keep retrying before abandoning the attempt to <a href="../../Lucy/Store/Lock.html#obtain" class="podlinkpod" +>obtain()</a> a lock.</li> + +<li><b>interval</b> - Time in milliseconds between retries.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::LockFactory isa Clownfish::Obj.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/RAMFolder.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/RAMFolder.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/RAMFolder.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/Lucy/Store/RAMFolder.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,57 @@ +Title: Lucy::Store::RAMFolder â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::RAMFolder - In-memory Folder implementation.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $folder = Lucy::Store::RAMFolder->new; + +# or sometimes... +my $folder = Lucy::Store::RAMFolder->new( + path => $relative_path, +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>RAMFolder is an entirely in-memory implementation of <a href="../../Lucy/Store/Folder.html" class="podlinkpod" +>Folder</a>, +primarily used for testing and development.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $folder = Lucy::Store::RAMFolder->new( + path => $relative_path, # default: empty string +);</pre> + +<p>Create a new RAMFolder.</p> + +<ul> +<li><b>path</b> - Relative path, +used for subfolders.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::RAMFolder isa <a href="../../Lucy/Store/Folder.html" class="podlinkpod" +>Lucy::Store::Folder</a> isa Clownfish::Obj.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocReader.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocReader.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocReader.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocReader.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,25 @@ +Title: LucyX::Index::ByteBufDocReader â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Index::ByteBufDocReader - Read a Doc as a fixed-width byte array.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre># See LucyX::Index::ByteBufDocWriter</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>This is a proof-of-concept class to demonstrate alternate implementations for fetching documents. +It is unsupported.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocWriter.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocWriter.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocWriter.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocWriter.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,90 @@ +Title: LucyX::Index::ByteBufDocWriter â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Index::ByteBufDocWriter - Write a Doc as a fixed-width byte array.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<p>Create an <a href="../../Lucy/Plan/Architecture.html" class="podlinkpod" +>Architecture</a> subclass which overrides register_doc_writer() and register_doc_reader():</p> + +<pre>package MyArchitecture; +use base qw( Lucy::Plan::Architecture ); +use LucyX::Index::ByteBufDocReader; +use LucyX::Index::ByteBufDocWriter; + +sub register_doc_writer { + my ( $self, $seg_writer ) = @_; + my $doc_writer = LucyX::Index::ByteBufDocWriter->new( + width => 16, + field => 'value', + snapshot => $seg_writer->get_snapshot, + segment => $seg_writer->get_segment, + polyreader => $seg_writer->get_polyreader, + ); + $seg_writer->register( + api => "Lucy::Index::DocReader", + component => $doc_writer, + ); + $seg_writer->add_writer($doc_writer); +} + +sub register_doc_reader { + my ( $self, $seg_reader ) = @_; + my $doc_reader = LucyX::Index::ByteBufDocReader->new( + width => 16, + field => 'value', + schema => $seg_reader->get_schema, + folder => $seg_reader->get_folder, + segments => $seg_reader->get_segments, + seg_tick => $seg_reader->get_seg_tick, + snapshot => $seg_reader->get_snapshot, + ); + $seg_reader->register( + api => 'Lucy::Index::DocReader', + component => $doc_reader, + ); +} + +package MySchema; +use base qw( Lucy::Plan::Schema ); + +sub architecture { MyArchitecture->new }</pre> + +<p>Proceed as normal in your indexer app, +making sure that every supplied document supplies a valid value for the field in question:</p> + +<pre>$indexer->add_doc({ + title => $title, + content => $content, + id => $id, # <---- Must meet spec. +});</pre> + +<p>Then, +in your search app:</p> + +<pre>my $searcher = Lucy::Search::IndexSearcher->new( + index => '/path/to/index', +); +my $hits = $searcher->hits( query => $query ); +while ( my $id = $hits->next ) { + my $real_doc = $external_document_source->fetch( $doc->{value} ); + ... +}</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>This is a proof-of-concept class to demonstrate alternate implementations for fetching documents. +It is unsupported.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/LongFieldSim.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/LongFieldSim.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/LongFieldSim.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/LongFieldSim.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,93 @@ +Title: LucyX::Index::LongFieldSim â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Index::LongFieldSim - Similarity optimized for long fields.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>package MySchema::body; +use base qw( Lucy::Plan::FullTextType ); +use LucyX::Index::LongFieldSim; +sub make_similarity { LucyX::Index::LongFieldSim->new }</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Apache Lucy's default <a href="../../Lucy/Index/Similarity.html" class="podlinkpod" +>Similarity</a> implmentation produces a bias towards extremely short fields.</p> + +<pre>Lucy::Index::Similarity + +| more weight +| * +| ** +| *** +| ********** +| ******************** +| ******************************* +| less weight **** +|------------------------------------------------------------------------ + fewer tokens more tokens</pre> + +<p>LongFieldSim eliminates this bias.</p> + +<pre>LucyX::Index::LongFieldSim + +| more weight +| +| +| +|***************** +| ******************** +| ******************************* +| less weight **** +|------------------------------------------------------------------------ + fewer tokens more tokens</pre> + +<p>In most cases, +the default bias towards short fields is desirable. +For instance, +say you have two documents:</p> + +<ul> +<li>"George Washington"</li> + +<li>"George Washington Carver"</li> +</ul> + +<p>If a user searches for "george washington", +we want the exact title match to appear first. +Under the default Similarity implementation it will, +because the "Carver" in "George Washington Carver" dilutes the impact of the other two tokens.</p> + +<p>However, +under LongFieldSim, +the two titles will yield equal scores. +That would be bad in this particular case, +but it could be good in another.</p> + +<pre> "George Washington Carver is cool." + + "George Washington Carver was born on the eve of the US Civil War, in + 1864. His exact date of birth is unknown... Carver's research in crop + rotation revolutionized agriculture..."</pre> + +<p>The first document is succinct, +but useless. +Unfortunately, +the default similarity will assess it as extremely relevant to a query of "george washington carver". +However, +under LongFieldSim, +the short-field bias is eliminated, +and the addition of other mentions of Carver's name in the second document yield a higher score and a higher rank.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocReader.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocReader.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocReader.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocReader.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,19 @@ +Title: LucyX::Index::ZlibDocReader â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Index::ZlibDocReader - Compressed doc storage.</p> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>This is a proof-of-concept class to demonstrate alternate implementations for fetching documents. +It is unsupported.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocWriter.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocWriter.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocWriter.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocWriter.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,19 @@ +Title: LucyX::Index::ZlibDocWriter â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Index::ZlibDocWriter - Compressed doc storage.</p> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>This is a proof-of-concept class to demonstrate alternate implementations for fetching documents. +It is unsupported.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/ClusterSearcher.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/ClusterSearcher.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/ClusterSearcher.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/ClusterSearcher.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,53 @@ +Title: LucyX::Remote::ClusterSearcher â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Remote::ClusterSearcher - Search multiple remote indexes.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $searcher = eval { + LucyX::Remote::ClusterSearcher->new( + schema => MySchema->new, + shards => [ 'search1:7890', 'search2:7890', 'search3:7890' ], + ); +}; +... +my $hits = eval { $searcher->hits( query => $query ) };</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>ClusterSearcher is a subclass of <a href="../../Lucy/Search/Searcher.html" class="podlinkpod" +>Lucy::Search::Searcher</a> which can be used to search a composite index made up of multiple shards, +where each shard is represented by a host:port pair running <a href="../../LucyX/Remote/SearchServer.html" class="podlinkpod" +>LucyX::Remote::SearchServer</a>.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<p>Constructor. +Takes hash-style params.</p> + +<ul> +<li><b>schema</b> - A Schema, +which must match the Schema used by each remote node.</li> + +<li><b>shards</b> - An array of host:port pairs running LucyX::Remote::SearchServer instances, +which identifying the shards that make up the composite index.</li> +</ul> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchClient.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchClient.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchClient.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchClient.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,48 @@ +Title: LucyX::Remote::SearchClient â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<p>Make a remote procedure call. +For every call that does not close/terminate the socket connection, +expect a response back that's been serialized using Storable.</p> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Remote::SearchClient - Connect to a remote SearchServer.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $client = LucyX::Remote::SearchClient->new( + peer_address => 'searchserver1:7890', +); +my $hits = $client->hits( query => $query );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>SearchClient is a subclass of <a href="../../Lucy/Search/Searcher.html" class="podlinkpod" +>Lucy::Search::Searcher</a> which can be used to search an index on a remote machine made accessible via <a href="../../LucyX/Remote/SearchServer.html" class="podlinkpod" +>SearchServer</a>.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<p>Constructor. +Takes hash-style params.</p> + +<ul> +<li><b>peer_address</b> - The name/IP and the port number which the client should attempt to connect to.</li> +</ul> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchServer.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchServer.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchServer.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchServer.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,86 @@ +Title: LucyX::Remote::SearchServer â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Remote::SearchServer - Make a Searcher remotely accessible.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $searcher = Lucy::Search::IndexSearcher->new( + index => '/path/to/index' +); +my $search_server = LucyX::Remote::SearchServer->new( + searcher => $searcher +); +$search_server->serve( + port => 7890 +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>The SearchServer class, +in conjunction with either <a href="../../LucyX/Remote/SearchClient.html" class="podlinkpod" +>SearchClient</a> or <a href="../../LucyX/Remote/ClusterSearcher.html" class="podlinkpod" +>ClusterSearcher</a>, +makes it possible to run a search on one machine and report results on another.</p> + +<p>By aggregating several SearchClients under a ClusterSearcher, +the cost of searching what might have been a prohibitively large monolithic index can be distributed across multiple nodes, +each with its own, +smaller index.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $search_server = LucyX::Remote::SearchServer->new( + searcher => $searcher, # required +);</pre> + +<p>Constructor. +Takes hash-style parameters.</p> + +<ul> +<li><b>searcher</b> - the <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod" +>Searcher</a> that the SearchServer will wrap.</li> +</ul> + +<h3><a class='u' +name="serve" +>serve</a></h3> + +<pre>$search_server->serve( + port => 7890, # required +);</pre> + +<p>Open a listening socket on localhost and wait for SearchClients to connect.</p> + +<ul> +<li><b>port</b> - the port on localhost that the server should open and listen on.</li> +</ul> + +<h3><a class='u' +name="serve_rpc" +>serve_rpc</a></h3> + +<pre>my $status = $search_server->serve_rpc($sock);</pre> + +<p>Handle a single RPC from socket $sock. +Returns 'done' if the connection should be closed. +Returns 'terminate' if the server should shut down. +Returns 'continue' if the server should continue to handle requests from this client.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/Filter.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/Filter.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/Filter.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/Filter.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,79 @@ +Title: LucyX::Search::Filter â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Search::Filter - Build a caching filter based on results of a Query.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my %category_filters; +for my $category (qw( sweet sour salty bitter )) { + my $cat_query = Lucy::Search::TermQuery->new( + field => 'category', + term => $category, + ); + $category_filters{$category} = LucyX::Search::Filter->new( + query => $cat_query, + ); +} + +while ( my $cgi = CGI::Fast->new ) { + my $user_query = $cgi->param('q'); + my $filter = $category_filters{ $cgi->param('category') }; + my $and_query = Lucy::Search::ANDQuery->new; + $and_query->add_child($user_query); + $and_query->add_child($filter); + my $hits = $searcher->hits( query => $and_query ); + ...</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>A Filter is a <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</a> subclass that can be used to filter the results of another Query. +The effect is very similar to simply using the wrapped inner query, +but there are two important differences:</p> + +<ul> +<li>A Filter does not contribute to the score of the documents it matches.</li> + +<li>A Filter caches its results, +so it is more efficient if you use it more than once.</li> +</ul> + +<p>To obtain logically equivalent results to the Filter but avoid the caching, +substitute the wrapped query but use set_boost() to set its <code>boost</code> to 0.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $filter = LucyX::Search::Filter->new( + query => $query; +);</pre> + +<p>Constructor. +Takes one hash-style parameter, +<code>query</code>, +which must be an object belonging to a subclass of <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</a>.</p> + +<h2><a class='u' +name="BUGS" +>BUGS</a></h2> + +<p>Filters do not cache when used in a search cluster with LucyX::Remote's SearchServer and SearchClient.</p> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/MockMatcher.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/MockMatcher.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/MockMatcher.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/MockMatcher.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,39 @@ +Title: LucyX::Search::MockMatcher â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Search::MockMatcher - Matcher with arbitrary docs and scores.</p> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Used for testing combining <a href="../../Lucy/Search/Matcher.html" class="podlinkpod" +>Matchers</a> such as ANDMatcher, +MockMatcher allows arbitrary match criteria to be supplied, +obviating the need for clever index construction to cover corner cases.</p> + +<p>MockMatcher is a testing and demonstration class; it is unsupported.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new(_[labeled_params]_)" +>new( [<i>labeled params</i>] )</a></h3> + +<ul> +<li><b>doc_ids</b> - A sorted array of <a href="../../Lucy/Docs/DocIDs.html" class="podlinkpod" +>doc_ids</a>.</li> + +<li><b>scores</b> - An array of scores, +one for each doc_id.</li> +</ul> + +</div> Added: lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/ProximityQuery.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/ProximityQuery.mdtext?rev=1762636&view=auto ============================================================================== --- lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/ProximityQuery.mdtext (added) +++ lucy/site/trunk/content/docs/0.5.0/perl/LucyX/Search/ProximityQuery.mdtext Wed Sep 28 12:06:24 2016 @@ -0,0 +1,110 @@ +Title: LucyX::Search::ProximityQuery â Apache Lucy Documentation + +<div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Search::ProximityQuery - Query matching an ordered list of terms.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $proximity_query = LucyX::Search::ProximityQuery->new( + field => 'content', + terms => [qw( the who )], + within => 10, # match within 10 positions +); +my $hits = $searcher->hits( query => $proximity_query );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>ProximityQuery is a subclass of <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Query</a> for matching against an ordered sequence of terms.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $proximity_query = LucyX::Search::ProximityQuery->new( + field => $field # required + terms => $terms # required + within => $within # required +);</pre> + +<p>Create a new ProximityQuery.</p> + +<ul> +<li><b>field</b> - The field that the phrase must occur in.</li> + +<li><b>terms</b> - The ordered array of terms that must match.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_field" +>get_field</a></h3> + +<pre>my $string = $proximity_query->get_field();</pre> + +<p>Accessor for object’s field attribute.</p> + +<h3><a class='u' +name="get_terms" +>get_terms</a></h3> + +<pre>my $arrayref = $proximity_query->get_terms();</pre> + +<p>Accessor for object’s array of terms.</p> + +<h3><a class='u' +name="get_within" +>get_within</a></h3> + +<pre>my $int = $proximity_query->get_within();</pre> + +<p>Accessor for object’s within attribute.</p> + +<h3><a class='u' +name="make_compiler" +>make_compiler</a></h3> + +<pre>my $compiler = $proximity_query->make_compiler( + searcher => $searcher # required + boost => $boost # required + subordinate => $subordinate # default: false +);</pre> + +<p>Abstract factory method returning a Compiler derived from this Query.</p> + +<ul> +<li><b>searcher</b> - A Searcher.</li> + +<li><b>boost</b> - A scoring multiplier.</li> + +<li><b>subordinate</b> - 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#normalize" class="podlinkpod" +>normalize()</a> on the newly minted Compiler object before returning it.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>LucyX::Search::ProximityQuery isa <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</a> isa Clownfish::Obj.</p> + +</div> Copied: lucy/site/trunk/content/docs/0.5.0/perl/clownfish-index.mdtext (from r1762634, lucy/site/trunk/content/docs/perl/clownfish-index.mdtext) URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/clownfish-index.mdtext?p2=lucy/site/trunk/content/docs/0.5.0/perl/clownfish-index.mdtext&p1=lucy/site/trunk/content/docs/perl/clownfish-index.mdtext&r1=1762634&r2=1762636&rev=1762636&view=diff ============================================================================== (empty) Copied: lucy/site/trunk/content/docs/0.5.0/perl/index.mdtext (from r1762634, lucy/site/trunk/content/docs/perl/index.mdtext) URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/0.5.0/perl/index.mdtext?p2=lucy/site/trunk/content/docs/0.5.0/perl/index.mdtext&p1=lucy/site/trunk/content/docs/perl/index.mdtext&r1=1762634&r2=1762636&rev=1762636&view=diff ============================================================================== (empty) Modified: lucy/site/trunk/content/docs/c/Clownfish/Blob.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/Blob.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/Blob.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/Blob.mdtext Wed Sep 28 12:06:24 2016 @@ -215,16 +215,6 @@ than <code>other</code>, and a positive </code></pre> <p>Return a clone of the object.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Blob_Destroy</strong>( - <span class="prefix">cfish_</span>Blob *<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>Clownfish::Blob is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Clownfish/Boolean.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/Boolean.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/Boolean.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/Boolean.mdtext Wed Sep 28 12:06:24 2016 @@ -82,16 +82,6 @@ value.</p> </code></pre> <p>Return âtrueâ for true values and âfalseâ for false values.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Bool_Destroy</strong>( - <span class="prefix">cfish_</span>Boolean *<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>Clownfish::Boolean is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Clownfish/ByteBuf.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/ByteBuf.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/ByteBuf.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/ByteBuf.mdtext Wed Sep 28 12:06:24 2016 @@ -311,16 +311,6 @@ less than <code>other</code>, and a posi </code></pre> <p>Return a clone of the object.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>BB_Destroy</strong>( - <span class="prefix">cfish_</span>ByteBuf *<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>Clownfish::ByteBuf is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Clownfish/CharBuf.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/CharBuf.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/CharBuf.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/CharBuf.mdtext Wed Sep 28 12:06:24 2016 @@ -237,16 +237,6 @@ allocation.</p> <p>Return the content of the CharBuf as <a href="../Clownfish/String.html">String</a> and clear the CharBuf. This is more efficient than <a href="../Clownfish/CharBuf.html#func_To_String">To_String()</a>.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>CB_Destroy</strong>( - <span class="prefix">cfish_</span>CharBuf *<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>Clownfish::CharBuf is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Clownfish/Class.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/Class.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/Class.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/Class.mdtext Wed Sep 28 12:06:24 2016 @@ -119,16 +119,6 @@ hierarchy.</p> </code></pre> <p>Return the number of bytes needed to hold an instance of the class.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Class_Destroy</strong>( - <span class="prefix">cfish_</span>Class *<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>Clownfish::Class is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Clownfish/Docs/BuildingProjects.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/Docs/BuildingProjects.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/Docs/BuildingProjects.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/Docs/BuildingProjects.mdtext Wed Sep 28 12:06:24 2016 @@ -85,5 +85,5 @@ compiled with <code>autogen/include</cod <h3>Linking</h3> <p>When linking, add the object files of the CFC-generated code created in the previous step. You must also link the shared library of the -Clownfish runtime (<code>-lcfish</code> under GCC).</p> +Clownfish runtime (<code>-lclownfish</code> under GCC).</p> </div> Modified: lucy/site/trunk/content/docs/c/Clownfish/Docs/WritingClasses.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/Docs/WritingClasses.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/Docs/WritingClasses.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/Docs/WritingClasses.mdtext Wed Sep 28 12:06:24 2016 @@ -33,7 +33,7 @@ are the parcel names. The values contain "nickname": "Pfind", "version": "v2.3.8", "prerequisites": { - "Clownfish": "v0.5.0" + "Clownfish": "v0.6.0" } } </code></pre> Modified: lucy/site/trunk/content/docs/c/Clownfish/Err.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/Err.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/Err.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/Err.mdtext Wed Sep 28 12:06:24 2016 @@ -96,16 +96,6 @@ Err so that it can be handled by Clownfi </code></pre> <p>Return the error message.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Err_Destroy</strong>( - <span class="prefix">cfish_</span>Err *<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>Clownfish::Err is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Clownfish/Hash.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/Hash.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/Hash.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/Hash.mdtext Wed Sep 28 12:06:24 2016 @@ -221,16 +221,6 @@ succeeds; otherwise NULL.</p> <code>self</code>. Keys and values are compared using their respective <code>Equals</code> methods.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Hash_Destroy</strong>( - <span class="prefix">cfish_</span>Hash *<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>Clownfish::Hash is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Clownfish/HashIterator.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/HashIterator.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/HashIterator.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/HashIterator.mdtext Wed Sep 28 12:06:24 2016 @@ -83,16 +83,6 @@ after the iterator was exhausted.</p> call this method before <a href="../Clownfish/HashIterator.html#func_Next">Next()</a> was called for the first time or after the iterator was exhausted.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>HashIter_Destroy</strong>( - <span class="prefix">cfish_</span>HashIterator *<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>Clownfish::HashIterator is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Clownfish/Obj.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/Obj.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/Obj.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/Obj.mdtext Wed Sep 28 12:06:24 2016 @@ -112,16 +112,6 @@ another.</p> <code>self</code> is less than <code>other</code>, and a positive number if <code>self</code> is greater than <code>other</code>.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Obj_Destroy</strong>( - <span class="prefix">cfish_</span>Obj *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</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> Modified: lucy/site/trunk/content/docs/c/Clownfish/String.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/String.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/String.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/String.mdtext Wed Sep 28 12:06:24 2016 @@ -28,6 +28,38 @@ Title: Clownfish::String â C API Do <p>Clownfish::String â Immutable string holding Unicode characters.</p> <h3>Functions</h3> <dl> +<dt id="func_utf8_valid">utf8_valid</dt> +<dd> +<pre><code>bool +<span class="prefix">cfish_</span><strong>Str_utf8_valid</strong>( + char *<strong>ptr</strong>, + size_t <strong>len</strong> +); +</code></pre> +<p>Return true if the string is valid UTF-8, false otherwise.</p> +</dd> +<dt id="func_validate_utf8">validate_utf8</dt> +<dd> +<pre><code>void +<span class="prefix">cfish_</span><strong>Str_validate_utf8</strong>( + char *<strong>text</strong>, + size_t <strong>size</strong>, + char *<strong>file</strong>, + int <strong>line</strong>, + char *<strong>func</strong> +); +</code></pre> +<p>Throws an error if the string isnât valid UTF-8.</p> +</dd> +<dt id="func_is_whitespace">is_whitespace</dt> +<dd> +<pre><code>bool +<span class="prefix">cfish_</span><strong>Str_is_whitespace</strong>( + int32_t <strong>code_point</strong> +); +</code></pre> +<p>Returns true if the code point qualifies as Unicode whitespace.</p> +</dd> <dt id="func_new_from_utf8">new_from_utf8</dt> <dd> <pre><code><span class="prefix">cfish_</span>String* <span class="comment">// incremented</span> @@ -641,16 +673,6 @@ backwards from the end. Return <code>CF </code></pre> <p>Return an iterator initialized to the end of the string.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Str_Destroy</strong>( - <span class="prefix">cfish_</span>String *<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>Clownfish::String is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Clownfish/StringIterator.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/StringIterator.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/StringIterator.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/StringIterator.mdtext Wed Sep 28 12:06:24 2016 @@ -250,16 +250,6 @@ supplied as raw UTF-8.</p> </dd> </dl> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>StrIter_Destroy</strong>( - <span class="prefix">cfish_</span>StringIterator *<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>Clownfish::StringIterator is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Clownfish/Vector.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Clownfish/Vector.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Clownfish/Vector.mdtext (original) +++ lucy/site/trunk/content/docs/c/Clownfish/Vector.mdtext Wed Sep 28 12:06:24 2016 @@ -245,16 +245,6 @@ fewer elements â potentially none.< <p><strong>Returns:</strong> true if <code>other</code> is a Vector with the same values as <code>self</code>. Values are compared using their respective <code>Equals</code> methods.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Vec_Destroy</strong>( - <span class="prefix">cfish_</span>Vector *<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>Clownfish::Vector is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: lucy/site/trunk/content/docs/c/Lucy/Object/BitVector.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Lucy/Object/BitVector.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Lucy/Object/BitVector.mdtext (original) +++ lucy/site/trunk/content/docs/c/Lucy/Object/BitVector.mdtext Wed Sep 28 12:06:24 2016 @@ -34,7 +34,7 @@ Title: Lucy::Object::BitVector â C <dd> <pre><code><span class="prefix">lucy_</span>BitVector* <span class="comment">// incremented</span> <span class="prefix">lucy_</span><strong>BitVec_new</strong>( - uint32_t <strong>capacity</strong> + size_t <strong>capacity</strong> ); </code></pre> <p>Create a new BitVector.</p> @@ -50,7 +50,7 @@ able to hold.</p> <pre><code><span class="prefix">lucy_</span>BitVector* <span class="prefix">lucy_</span><strong>BitVec_init</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>capacity</strong> + size_t <strong>capacity</strong> ); </code></pre> <p>Initialize a BitVector.</p> @@ -69,7 +69,7 @@ able to hold.</p> <pre><code>bool <span class="prefix">lucy_</span><strong>BitVec_Get</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Return true if the bit at <code>tick</code> has been set, false if it @@ -86,7 +86,7 @@ objectâs capacity).</p> <pre><code>void <span class="prefix">lucy_</span><strong>BitVec_Set</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Set the bit at <code>tick</code> to 1.</p> @@ -101,7 +101,7 @@ objectâs capacity).</p> <pre><code>int32_t <span class="prefix">lucy_</span><strong>BitVec_Next_Hit</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Returns the next set bit equal to or greater than <code>tick</code>, @@ -112,7 +112,7 @@ or -1 if no such bit exists.</p> <pre><code>void <span class="prefix">lucy_</span><strong>BitVec_Clear</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Clear the indicated bit. (i.e. set it to 0).</p> @@ -136,7 +136,7 @@ or -1 if no such bit exists.</p> <pre><code>void <span class="prefix">lucy_</span><strong>BitVec_Grow</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>capacity</strong> + size_t <strong>capacity</strong> ); </code></pre> <p>If the BitVector does not already have enough room to hold the @@ -215,7 +215,7 @@ BitVector if they were not already set.< <pre><code>void <span class="prefix">lucy_</span><strong>BitVec_Flip</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Invert the value of a bit.</p> @@ -230,8 +230,8 @@ BitVector if they were not already set.< <pre><code>void <span class="prefix">lucy_</span><strong>BitVec_Flip_Block</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>offset</strong>, - uint32_t <strong>length</strong> + size_t <strong>offset</strong>, + size_t <strong>length</strong> ); </code></pre> <p>Invert each bit within a contiguous block.</p> @@ -246,7 +246,7 @@ BitVector if they were not already set.< </dd> <dt id="func_Count">Count</dt> <dd> -<pre><code>uint32_t +<pre><code>size_t <span class="prefix">lucy_</span><strong>BitVec_Count</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong> ); Modified: lucy/site/trunk/content/docs/c/Lucy/Object/I32Array.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Lucy/Object/I32Array.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Lucy/Object/I32Array.mdtext (original) +++ lucy/site/trunk/content/docs/c/Lucy/Object/I32Array.mdtext Wed Sep 28 12:06:24 2016 @@ -33,7 +33,7 @@ Title: Lucy::Object::I32Array â C A <pre><code><span class="prefix">lucy_</span>I32Array* <span class="comment">// incremented</span> <span class="prefix">lucy_</span><strong>I32Arr_new</strong>( int32_t *<strong>ints</strong>, - uint32_t <strong>size</strong> + size_t <strong>size</strong> ); </code></pre> </dd> @@ -41,7 +41,7 @@ Title: Lucy::Object::I32Array â C A <dd> <pre><code><span class="prefix">lucy_</span>I32Array* <span class="comment">// incremented</span> <span class="prefix">lucy_</span><strong>I32Arr_new_blank</strong>( - uint32_t <strong>size</strong> + size_t <strong>size</strong> ); </code></pre> </dd> @@ -51,7 +51,7 @@ Title: Lucy::Object::I32Array â C A <span class="prefix">lucy_</span><strong>I32Arr_init</strong>( <span class="prefix">lucy_</span>I32Array *<strong>self</strong>, int32_t *<strong>ints</strong>, - uint32_t <strong>size</strong> + size_t <strong>size</strong> ); </code></pre> </dd> @@ -63,7 +63,7 @@ Title: Lucy::Object::I32Array â C A <pre><code>void <span class="prefix">lucy_</span><strong>I32Arr_Set</strong>( <span class="prefix">lucy_</span>I32Array *<strong>self</strong>, - uint32_t <strong>tick</strong>, + size_t <strong>tick</strong>, int32_t <strong>value</strong> ); </code></pre> @@ -75,7 +75,7 @@ Title: Lucy::Object::I32Array â C A <pre><code>int32_t <span class="prefix">lucy_</span><strong>I32Arr_Get</strong>( <span class="prefix">lucy_</span>I32Array *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Return the value at <code>tick</code>, or throw an error if @@ -83,7 +83,7 @@ Title: Lucy::Object::I32Array â C A </dd> <dt id="func_Get_Size">Get_Size</dt> <dd> -<pre><code>uint32_t +<pre><code>size_t <span class="prefix">lucy_</span><strong>I32Arr_Get_Size</strong>( <span class="prefix">lucy_</span>I32Array *<strong>self</strong> ); Modified: lucy/site/trunk/content/docs/c/Lucy/Simple.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Lucy/Simple.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/Lucy/Simple.mdtext (original) +++ lucy/site/trunk/content/docs/c/Lucy/Simple.mdtext Wed Sep 28 12:06:24 2016 @@ -100,7 +100,8 @@ indicated by a two-letter ISO code. 12 <span class="prefix">lucy_</span>Simple *<strong>self</strong>, <span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a> *<strong>query</strong>, uint32_t <strong>offset</strong>, - uint32_t <strong>num_wanted</strong> + uint32_t <strong>num_wanted</strong>, + <span class="prefix">lucy_</span><a href="../Lucy/Search/SortSpec.html">SortSpec</a> *<strong>sort_spec</strong> ); </code></pre> <p>Search the index. Returns the total number of documents which match @@ -119,6 +120,10 @@ found.</p> <dd><p>The number of hits you would like to see after <code>offset</code> is taken into account.</p> </dd> +<dt>sort_spec</dt> +<dd><p>A <a href="../Lucy/Search/SortSpec.html">SortSpec</a>, which will affect how results are +ranked and returned.</p> +</dd> </dl> </dd> <dt id="func_Next">Next</dt> Modified: lucy/site/trunk/content/docs/index.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/index.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/index.mdtext (original) +++ lucy/site/trunk/content/docs/index.mdtext Wed Sep 28 12:06:24 2016 @@ -2,11 +2,11 @@ Title: Apache Lucy Documentation ## Perl API - - [Apache Lucy 0.5.0](perl/) - - [Apache Clownfish 0.5.0](perl/clownfish-index.html) + - [Apache Lucy 0.6.0](perl/) + - [Apache Clownfish 0.6.0](perl/clownfish-index.html) ## C API - - [Apache Lucy 0.5.0](c/lucy.html) - - [Apache Clownfish 0.5.0](c/cfish.html) + - [Apache Lucy 0.6.0](c/lucy.html) + - [Apache Clownfish 0.6.0](c/cfish.html) Modified: lucy/site/trunk/content/docs/perl/Clownfish/Docs/BuildingProjects.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/Clownfish/Docs/BuildingProjects.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/perl/Clownfish/Docs/BuildingProjects.mdtext (original) +++ lucy/site/trunk/content/docs/perl/Clownfish/Docs/BuildingProjects.mdtext Wed Sep 28 12:06:24 2016 @@ -149,6 +149,6 @@ name="Linking" <p>When linking, add the object files of the CFC-generated code created in the previous step. -You must also link the shared library of the Clownfish runtime (<code>-lcfish</code> under GCC).</p> +You must also link the shared library of the Clownfish runtime (<code>-lclownfish</code> under GCC).</p> </div> Modified: lucy/site/trunk/content/docs/perl/Clownfish/Docs/WritingClasses.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/Clownfish/Docs/WritingClasses.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/perl/Clownfish/Docs/WritingClasses.mdtext (original) +++ lucy/site/trunk/content/docs/perl/Clownfish/Docs/WritingClasses.mdtext Wed Sep 28 12:06:24 2016 @@ -50,7 +50,7 @@ The values contain the minimum required "nickname": "Pfind", "version": "v2.3.8", "prerequisites": { - "Clownfish": "v0.5.0" + "Clownfish": "v0.6.0" } }</pre> Modified: lucy/site/trunk/content/docs/perl/Lucy.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/Lucy.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/perl/Lucy.mdtext (original) +++ lucy/site/trunk/content/docs/perl/Lucy.mdtext Wed Sep 28 12:06:24 2016 @@ -13,7 +13,7 @@ name="NAME" name="VERSION" >VERSION</a></h2> -<p>0.5.0</p> +<p>0.6.0</p> <h2><a class='u' name="SYNOPSIS" Modified: lucy/site/trunk/content/docs/perl/Lucy/Simple.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/Lucy/Simple.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/perl/Lucy/Simple.mdtext (original) +++ lucy/site/trunk/content/docs/perl/Lucy/Simple.mdtext Wed Sep 28 12:06:24 2016 @@ -118,6 +118,7 @@ name="search" query => $query # required offset => $offset # default: 0 num_wanted => $num_wanted # default: 10 + sort_spec => $sort_spec # default: undef );</pre> <p>Search the index. @@ -133,6 +134,10 @@ Setting offset to 20 and num_wanted to 1 assuming that 30 hits can be found.</li> <li><b>num_wanted</b> - The number of hits you would like to see after <code>offset</code> is taken into account.</li> + +<li><b>sort_spec</b> - A <a href="../Lucy/Search/SortSpec.html" class="podlinkpod" +>SortSpec</a>, +which will affect how results are ranked and returned.</li> </ul> <h3><a class='u' Modified: lucy/site/trunk/content/docs/perl/clownfish-index.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/clownfish-index.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/perl/clownfish-index.mdtext (original) +++ lucy/site/trunk/content/docs/perl/clownfish-index.mdtext Wed Sep 28 12:06:24 2016 @@ -1,6 +1,6 @@ -Title: Perl API documentation for Apache Clownfish 0.5.0 +Title: Perl API documentation for Apache Clownfish 0.6.0 -## Perl API documentation for Apache Clownfish 0.5.0 +## Perl API documentation for Apache Clownfish 0.6.0 - [Clownfish](Clownfish.html) â Apache Clownfish symbiotic object system - [Clownfish::Blob](Clownfish/Blob.html) â Immutable buffer holding arbitrary bytes. Modified: lucy/site/trunk/content/docs/perl/index.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/index.mdtext?rev=1762636&r1=1762635&r2=1762636&view=diff ============================================================================== --- lucy/site/trunk/content/docs/perl/index.mdtext (original) +++ lucy/site/trunk/content/docs/perl/index.mdtext Wed Sep 28 12:06:24 2016 @@ -1,6 +1,6 @@ -Title: Perl API documentation for Apache Lucy 0.5.0 +Title: Perl API documentation for Apache Lucy 0.6.0 -## Perl API documentation for Apache Lucy 0.5.0 +## Perl API documentation for Apache Lucy 0.6.0 - [Lucy](Lucy.html) â Apache Lucy search engine library. - [Lucy::Analysis::Analyzer](Lucy/Analysis/Analyzer.html) â Tokenize/modify/filter text.
