You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by bu...@apache.org on 2016/02/26 14:44:49 UTC
svn commit: r981214 [4/6] - in /websites/staging/lucy/trunk/content: ./
docs/test/ docs/test/Lucy/ docs/test/Lucy/Analysis/ docs/test/Lucy/Docs/
docs/test/Lucy/Docs/Cookbook/ docs/test/Lucy/Docs/Tutorial/
docs/test/Lucy/Document/ docs/test/Lucy/Highlig...
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PolyReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PolyReader.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PolyReader.html Fri Feb 26 13:44:48 2016
@@ -81,20 +81,23 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $polyreader = Lucy::Index::IndexReader->open(
- index => '/path/to/index',
- );
- my $doc_reader = $polyreader->obtain("Lucy::Index::DocReader");
- for my $doc_id ( 1 .. $polyreader->doc_max ) {
- my $doc = $doc_reader->fetch_doc($doc_id);
- print " $doc_id: $doc->{title}\n";
- }</pre>
+<pre>my $polyreader = Lucy::Index::IndexReader->open(
+ index => '/path/to/index',
+);
+my $doc_reader = $polyreader->obtain("Lucy::Index::DocReader");
+for my $doc_id ( 1 .. $polyreader->doc_max ) {
+ my $doc = $doc_reader->fetch_doc($doc_id);
+ print " $doc_id: $doc->{title}\n";
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>PolyReader conflates index data from multiple segments. For instance, if an index contains three segments with 10 documents each, PolyReader’s <a href="../../Lucy/Index/IndexReader.html#doc_max" class="podlinkpod"
+<p>PolyReader conflates index data from multiple segments.
+For instance,
+if an index contains three segments with 10 documents each,
+PolyReader’s <a href="../../Lucy/Index/IndexReader.html#doc_max" class="podlinkpod"
>doc_max()</a> method will return 30.</p>
<p>Some of PolyReader’s <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
@@ -109,23 +112,26 @@ name="METHODS"
name="doc_max"
>doc_max</a></h3>
-<pre> my $retval = $poly_reader->doc_max();</pre>
+<pre>my $retval = $poly_reader->doc_max();</pre>
-<p>Return the maximum number of documents available to the reader, which is also the highest possible internal document id. Documents which have been marked as deleted but not yet purged from the index are included in this count.</p>
+<p>Return the maximum number of documents available to the reader,
+which is also the highest possible internal document id.
+Documents which have been marked as deleted but not yet purged from the index are included in this count.</p>
<h3><a class='u'
name="doc_count"
>doc_count</a></h3>
-<pre> my $retval = $poly_reader->doc_count();</pre>
+<pre>my $retval = $poly_reader->doc_count();</pre>
-<p>Return the number of documents available to the reader, subtracting any that are marked as deleted.</p>
+<p>Return the number of documents available to the reader,
+subtracting any that are marked as deleted.</p>
<h3><a class='u'
name="del_count"
>del_count</a></h3>
-<pre> my $retval = $poly_reader->del_count();</pre>
+<pre>my $retval = $poly_reader->del_count();</pre>
<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
@@ -133,15 +139,16 @@ name="del_count"
name="offsets"
>offsets</a></h3>
-<pre> my $retval = $poly_reader->offsets();</pre>
+<pre>my $retval = $poly_reader->offsets();</pre>
-<p>Return an array with one entry for each segment, corresponding to segment doc_id start offset.</p>
+<p>Return an array with one entry for each segment,
+corresponding to segment doc_id start offset.</p>
<h3><a class='u'
name="seg_readers"
>seg_readers</a></h3>
-<pre> my $retval = $poly_reader->seg_readers();</pre>
+<pre>my $retval = $poly_reader->seg_readers();</pre>
<p>Return an array of all the SegReaders represented within the IndexReader.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingList.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingList.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingList.html Fri Feb 26 13:44:48 2016
@@ -81,15 +81,15 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $posting_list_reader
- = $seg_reader->obtain("Lucy::Index::PostingListReader");
- my $posting_list = $posting_list_reader->posting_list(
- field => 'content',
- term => 'foo',
- );
- while ( my $doc_id = $posting_list->next ) {
- say "Matching doc id: $doc_id";
- }</pre>
+<pre>my $posting_list_reader
+ = $seg_reader->obtain("Lucy::Index::PostingListReader");
+my $posting_list = $posting_list_reader->posting_list(
+ field => 'content',
+ term => 'foo',
+);
+while ( my $doc_id = $posting_list->next ) {
+ say "Matching doc id: $doc_id";
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -108,21 +108,24 @@ name="ABSTRACT_METHODS"
name="get_doc_freq"
>get_doc_freq</a></h3>
-<pre> my $retval = $posting_list->get_doc_freq();</pre>
+<pre>my $retval = $posting_list->get_doc_freq();</pre>
-<p>Return the number of documents that the PostingList contains. (This number will include any documents which have been marked as deleted but not yet purged.)</p>
+<p>Return the number of documents that the PostingList contains.
+(This number will include any documents which have been marked as deleted but not yet purged.)</p>
<h3><a class='u'
name="seek"
>seek</a></h3>
-<pre> $posting_list->seek($target);
- $posting_list->seek(); # default: undef</pre>
+<pre>$posting_list->seek($target);
+$posting_list->seek(); # default: undef</pre>
<p>Prepare the PostingList object to iterate over matches for documents that match <code>target</code>.</p>
<ul>
-<li><b>target</b> - The term to match. If undef, the iterator will be empty.</li>
+<li><b>target</b> - The term to match.
+If undef,
+the iterator will be empty.</li>
</ul>
<h2><a class='u'
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingListReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingListReader.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingListReader.html Fri Feb 26 13:44:48 2016
@@ -81,12 +81,12 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $posting_list_reader
- = $seg_reader->obtain("Lucy::Index::PostingListReader");
- my $posting_list = $posting_list_reader->posting_list(
- field => 'title',
- term => 'foo',
- );</pre>
+<pre>my $posting_list_reader
+ = $seg_reader->obtain("Lucy::Index::PostingListReader");
+my $posting_list = $posting_list_reader->posting_list(
+ field => 'title',
+ term => 'foo',
+);</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -103,17 +103,19 @@ name="ABSTRACT_METHODS"
name="posting_list"
>posting_list</a></h3>
-<pre> my $retval = $posting_list_reader->posting_list(
- field => $field # default: undef
- term => $term # default: undef
- );</pre>
+<pre>my $retval = $posting_list_reader->posting_list(
+ field => $field # default: undef
+ term => $term # default: undef
+);</pre>
-<p>Returns a PostingList, or undef if either <code>field</code> is undef or <code>field</code> is not present in any documents.</p>
+<p>Returns a PostingList,
+or undef if either <code>field</code> is undef or <code>field</code> is not present in any documents.</p>
<ul>
<li><b>field</b> - A field name.</li>
-<li><b>term</b> - If supplied, the PostingList will be pre-located to this term using <a href="../../Lucy/Index/PostingList.html#seek" class="podlinkpod"
+<li><b>term</b> - If supplied,
+the PostingList will be pre-located to this term using <a href="../../Lucy/Index/PostingList.html#seek" class="podlinkpod"
>seek()</a>.</li>
</ul>
@@ -125,10 +127,10 @@ name="METHODS"
name="aggregator"
>aggregator</a></h3>
-<pre> my $retval = $posting_list_reader->aggregator(
- readers => $readers # required
- offsets => $offsets # required
- );</pre>
+<pre>my $retval = $posting_list_reader->aggregator(
+ readers => $readers # required
+ offsets => $offsets # required
+);</pre>
<p>Returns undef since PostingLists may only be iterated at the segment level.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegReader.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegReader.html Fri Feb 26 13:44:48 2016
@@ -81,20 +81,20 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $polyreader = Lucy::Index::IndexReader->open(
- index => '/path/to/index',
- );
- my $seg_readers = $polyreader->seg_readers;
- for my $seg_reader (@$seg_readers) {
- my $seg_name = $seg_reader->get_seg_name;
- my $num_docs = $seg_reader->doc_max;
- print "Segment $seg_name ($num_docs documents):\n";
- my $doc_reader = $seg_reader->obtain("Lucy::Index::DocReader");
- for my $doc_id ( 1 .. $num_docs ) {
- my $doc = $doc_reader->fetch_doc($doc_id);
- print " $doc_id: $doc->{title}\n";
- }
- }</pre>
+<pre>my $polyreader = Lucy::Index::IndexReader->open(
+ index => '/path/to/index',
+);
+my $seg_readers = $polyreader->seg_readers;
+for my $seg_reader (@$seg_readers) {
+ my $seg_name = $seg_reader->get_seg_name;
+ my $num_docs = $seg_reader->doc_max;
+ print "Segment $seg_name ($num_docs documents):\n";
+ my $doc_reader = $seg_reader->obtain("Lucy::Index::DocReader");
+ for my $doc_id ( 1 .. $num_docs ) {
+ my $doc = $doc_reader->fetch_doc($doc_id);
+ print " $doc_id: $doc->{title}\n";
+ }
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -102,7 +102,8 @@ name="DESCRIPTION"
<p>SegReader interprets the data within a single segment of an index.</p>
-<p>Generally speaking, only advanced users writing subclasses which manipulate data at the segment level need to deal with the SegReader API directly.</p>
+<p>Generally speaking,
+only advanced users writing subclasses which manipulate data at the segment level need to deal with the SegReader API directly.</p>
<p>Nearly all of SegReader’s functionality is implemented by pluggable components spawned by <a href="../../Lucy/Plan/Architecture.html" class="podlinkpod"
>Architecture</a>’s factory methods.</p>
@@ -115,7 +116,7 @@ name="METHODS"
name="get_seg_name"
>get_seg_name</a></h3>
-<pre> my $retval = $seg_reader->get_seg_name();</pre>
+<pre>my $retval = $seg_reader->get_seg_name();</pre>
<p>Return the name of the segment.</p>
@@ -123,7 +124,7 @@ name="get_seg_name"
name="get_seg_num"
>get_seg_num</a></h3>
-<pre> my $retval = $seg_reader->get_seg_num();</pre>
+<pre>my $retval = $seg_reader->get_seg_num();</pre>
<p>Return the number of the segment.</p>
@@ -131,7 +132,7 @@ name="get_seg_num"
name="del_count"
>del_count</a></h3>
-<pre> my $retval = $seg_reader->del_count();</pre>
+<pre>my $retval = $seg_reader->del_count();</pre>
<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
@@ -139,31 +140,35 @@ name="del_count"
name="doc_max"
>doc_max</a></h3>
-<pre> my $retval = $seg_reader->doc_max();</pre>
+<pre>my $retval = $seg_reader->doc_max();</pre>
-<p>Return the maximum number of documents available to the reader, which is also the highest possible internal document id. Documents which have been marked as deleted but not yet purged from the index are included in this count.</p>
+<p>Return the maximum number of documents available to the reader,
+which is also the highest possible internal document id.
+Documents which have been marked as deleted but not yet purged from the index are included in this count.</p>
<h3><a class='u'
name="doc_count"
>doc_count</a></h3>
-<pre> my $retval = $seg_reader->doc_count();</pre>
+<pre>my $retval = $seg_reader->doc_count();</pre>
-<p>Return the number of documents available to the reader, subtracting any that are marked as deleted.</p>
+<p>Return the number of documents available to the reader,
+subtracting any that are marked as deleted.</p>
<h3><a class='u'
name="_offsets"
>_offsets</a></h3>
-<pre> my $retval = $seg_reader->_offsets();</pre>
+<pre>my $retval = $seg_reader->_offsets();</pre>
-<p>Return an array with one entry for each segment, corresponding to segment doc_id start offset.</p>
+<p>Return an array with one entry for each segment,
+corresponding to segment doc_id start offset.</p>
<h3><a class='u'
name="seg_readers"
>seg_readers</a></h3>
-<pre> my $retval = $seg_reader->seg_readers();</pre>
+<pre>my $retval = $seg_reader->seg_readers();</pre>
<p>Return an array of all the SegReaders represented within the IndexReader.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegWriter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegWriter.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegWriter.html Fri Feb 26 13:44:48 2016
@@ -103,13 +103,15 @@ name="METHODS"
name="register"
>register</a></h3>
-<pre> $seg_writer->register(
- api => $api # required
- component => $component # required
- );</pre>
-
-<p>Register a DataWriter component with the SegWriter. (Note that registration simply makes the writer available via <a href="#fetch" class="podlinkpod"
->fetch()</a>, so you may also want to call <a href="#add_writer" class="podlinkpod"
+<pre>$seg_writer->register(
+ api => $api # required
+ component => $component # required
+);</pre>
+
+<p>Register a DataWriter component with the SegWriter.
+(Note that registration simply makes the writer available via <a href="#fetch" class="podlinkpod"
+>fetch()</a>,
+so you may also want to call <a href="#add_writer" class="podlinkpod"
>add_writer()</a>).</p>
<ul>
@@ -122,7 +124,7 @@ name="register"
name="fetch"
>fetch</a></h3>
-<pre> my $retval = $seg_writer->fetch($api);</pre>
+<pre>my $retval = $seg_writer->fetch($api);</pre>
<p>Retrieve a registered component.</p>
@@ -134,7 +136,7 @@ name="fetch"
name="add_writer"
>add_writer</a></h3>
-<pre> $seg_writer->add_writer($writer);</pre>
+<pre>$seg_writer->add_writer($writer);</pre>
<p>Add a DataWriter to the SegWriter’s stack of writers.</p>
@@ -142,37 +144,45 @@ name="add_writer"
name="add_doc"
>add_doc</a></h3>
-<pre> $seg_writer->add_doc(
- doc => $doc # required
- boost => $boost # default: 1.0
- );</pre>
-
-<p>Add a document to the segment. Inverts <code>doc</code>, increments the Segment’s internal document id, then calls Add_Inverted_Doc(), feeding all sub-writers.</p>
+<pre>$seg_writer->add_doc(
+ doc => $doc # required
+ boost => $boost # default: 1.0
+);</pre>
+
+<p>Add a document to the segment.
+Inverts <code>doc</code>,
+increments the Segment’s internal document id,
+then calls Add_Inverted_Doc(),
+feeding all sub-writers.</p>
<h3><a class='u'
name="add_segment"
>add_segment</a></h3>
-<pre> $seg_writer->add_segment(
- reader => $reader # required
- doc_map => $doc_map # default: undef
- );</pre>
+<pre>$seg_writer->add_segment(
+ reader => $reader # required
+ doc_map => $doc_map # default: undef
+);</pre>
<p>Add content from an existing segment into the one currently being written.</p>
<ul>
<li><b>reader</b> - The SegReader containing content to add.</li>
-<li><b>doc_map</b> - An array of integers mapping old document ids to new. Deleted documents are mapped to 0, indicating that they should be skipped.</li>
+<li><b>doc_map</b> - An array of integers mapping old document ids to new.
+Deleted documents are mapped to 0,
+indicating that they should be skipped.</li>
</ul>
<h3><a class='u'
name="finish"
>finish</a></h3>
-<pre> $seg_writer->finish();</pre>
+<pre>$seg_writer->finish();</pre>
-<p>Complete the segment: close all streams, store metadata, etc.</p>
+<p>Complete the segment: close all streams,
+store metadata,
+etc.</p>
<h2><a class='u'
name="INHERITANCE"
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Segment.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Segment.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Segment.html Fri Feb 26 13:44:48 2016
@@ -81,43 +81,53 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> # Index-time.
- package MyDataWriter;
- use base qw( Lucy::Index::DataWriter );
-
- sub finish {
- my $self = shift;
- my $segment = $self->get_segment;
- my $metadata = $self->SUPER::metadata();
- $metadata->{foo} = $self->get_foo;
- $segment->store_metadata(
- key => 'my_component',
- metadata => $metadata
- );
+<pre># Index-time.
+package MyDataWriter;
+use base qw( Lucy::Index::DataWriter );
+
+sub finish {
+ my $self = shift;
+ my $segment = $self->get_segment;
+ my $metadata = $self->SUPER::metadata();
+ $metadata->{foo} = $self->get_foo;
+ $segment->store_metadata(
+ key => 'my_component',
+ metadata => $metadata
+ );
+}
+
+# Search-time.
+package MyDataReader;
+use base qw( Lucy::Index::DataReader );
+
+sub new {
+ my $self = shift->SUPER::new(@_);
+ my $segment = $self->get_segment;
+ my $metadata = $segment->fetch_metadata('my_component');
+ if ($metadata) {
+ $self->set_foo( $metadata->{foo} );
+ ...
}
-
- # Search-time.
- package MyDataReader;
- use base qw( Lucy::Index::DataReader );
-
- sub new {
- my $self = shift->SUPER::new(@_);
- my $segment = $self->get_segment;
- my $metadata = $segment->fetch_metadata('my_component');
- if ($metadata) {
- $self->set_foo( $metadata->{foo} );
- ...
- }
- return $self;
- }</pre>
+ return $self;
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>Apache Lucy’s indexes are made up of individual “segments”, each of which is is an independent inverted index. On the file system, each segment is a directory within the main index directory whose name starts with “seg_”: “seg_2”, “seg_5a”, etc.</p>
-
-<p>Each Segment object keeps track of information about an index segment: its fields, document count, and so on. The Segment object itself writes one file, <code>segmeta.json</code>; besides storing info needed by Segment itself, the “segmeta” file serves as a central repository for metadata generated by other index components – relieving them of the burden of storing metadata themselves.</p>
+<p>Apache Lucy’s indexes are made up of individual “segments”,
+each of which is is an independent inverted index.
+On the file system,
+each segment is a directory within the main index directory whose name starts with “seg_”: “seg_2”,
+“seg_5a”,
+etc.</p>
+
+<p>Each Segment object keeps track of information about an index segment: its fields,
+document count,
+and so on.
+The Segment object itself writes one file,
+<code>segmeta.json</code>; besides storing info needed by Segment itself,
+the “segmeta” file serves as a central repository for metadata generated by other index components – relieving them of the burden of storing metadata themselves.</p>
<h2><a class='u'
name="METHODS"
@@ -127,26 +137,31 @@ name="METHODS"
name="add_field"
>add_field</a></h3>
-<pre> my $retval = $segment->add_field($field);</pre>
+<pre>my $retval = $segment->add_field($field);</pre>
-<p>Register a new field and assign it a field number. If the field was already known, nothing happens.</p>
+<p>Register a new field and assign it a field number.
+If the field was already known,
+nothing happens.</p>
<ul>
<li><b>field</b> - Field name.</li>
</ul>
-<p>Returns: the field’s field number, which is a positive integer.</p>
+<p>Returns: the field’s field number,
+which is a positive integer.</p>
<h3><a class='u'
name="store_metadata"
>store_metadata</a></h3>
-<pre> $segment->store_metadata(
- key => $key # required
- metadata => $metadata # required
- );</pre>
-
-<p>Store arbitrary information in the segment’s metadata Hash, to be serialized later. Throws an error if <code>key</code> is used twice.</p>
+<pre>$segment->store_metadata(
+ key => $key # required
+ metadata => $metadata # required
+);</pre>
+
+<p>Store arbitrary information in the segment’s metadata Hash,
+to be serialized later.
+Throws an error if <code>key</code> is used twice.</p>
<ul>
<li><b>key</b> - String identifying an index component.</li>
@@ -158,7 +173,7 @@ name="store_metadata"
name="fetch_metadata"
>fetch_metadata</a></h3>
-<pre> my $retval = $segment->fetch_metadata($key);</pre>
+<pre>my $retval = $segment->fetch_metadata($key);</pre>
<p>Fetch a value from the Segment’s metadata hash.</p>
@@ -166,9 +181,11 @@ name="fetch_metadata"
name="field_num"
>field_num</a></h3>
-<pre> my $retval = $segment->field_num($field);</pre>
+<pre>my $retval = $segment->field_num($field);</pre>
-<p>Given a field name, return its field number for this segment (which may differ from its number in other segments). Return 0 (an invalid field number) if the field name can’t be found.</p>
+<p>Given a field name,
+return its field number for this segment (which may differ from its number in other segments).
+Return 0 (an invalid field number) if the field name can’t be found.</p>
<ul>
<li><b>field</b> - Field name.</li>
@@ -178,15 +195,17 @@ name="field_num"
name="field_name"
>field_name</a></h3>
-<pre> my $retval = $segment->field_name($field_num);</pre>
+<pre>my $retval = $segment->field_name($field_num);</pre>
-<p>Given a field number, return the name of its field, or undef if the field name can’t be found.</p>
+<p>Given a field number,
+return the name of its field,
+or undef if the field name can’t be found.</p>
<h3><a class='u'
name="get_name"
>get_name</a></h3>
-<pre> my $retval = $segment->get_name();</pre>
+<pre>my $retval = $segment->get_name();</pre>
<p>Getter for the object’s seg name.</p>
@@ -194,7 +213,7 @@ name="get_name"
name="get_number"
>get_number</a></h3>
-<pre> my $retval = $segment->get_number();</pre>
+<pre>my $retval = $segment->get_number();</pre>
<p>Getter for the segment number.</p>
@@ -202,7 +221,7 @@ name="get_number"
name="set_count"
>set_count</a></h3>
-<pre> $segment->set_count($count);</pre>
+<pre>$segment->set_count($count);</pre>
<p>Setter for the object’s document count.</p>
@@ -210,7 +229,7 @@ name="set_count"
name="get_count"
>get_count</a></h3>
-<pre> my $retval = $segment->get_count();</pre>
+<pre>my $retval = $segment->get_count();</pre>
<p>Getter for the object’s document count.</p>
@@ -218,7 +237,7 @@ name="get_count"
name="compare_to"
>compare_to</a></h3>
-<pre> my $retval = $segment->compare_to($other);</pre>
+<pre>my $retval = $segment->compare_to($other);</pre>
<p>Compare by segment number.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Similarity.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Similarity.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Similarity.html Fri Feb 26 13:44:48 2016
@@ -81,24 +81,30 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> package MySimilarity;
+<pre>package MySimilarity;
- sub length_norm { return 1.0 } # disable length normalization
+sub length_norm { return 1.0 } # disable length normalization
- package MyFullTextType;
- use base qw( Lucy::Plan::FullTextType );
+package MyFullTextType;
+use base qw( Lucy::Plan::FullTextType );
- sub make_similarity { MySimilarity->new }</pre>
+sub make_similarity { MySimilarity->new }</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>After determining whether a document matches a given query, a score must be calculated which indicates how <i>well</i> the document matches the query. The Similarity class is used to judge how “similar” the query and the document are to each other; the closer the resemblance, they higher the document scores.</p>
+<p>After determining whether a document matches a given query,
+a score must be calculated which indicates how <i>well</i> the document matches the query.
+The Similarity class is used to judge how “similar” the query and the document are to each other; the closer the resemblance,
+they higher the document scores.</p>
+
+<p>The default implementation uses Lucene’s modified cosine similarity measure.
+Subclasses might tweak the existing algorithms,
+or might be used in conjunction with custom Query subclasses to implement arbitrary scoring schemes.</p>
-<p>The default implementation uses Lucene’s modified cosine similarity measure. Subclasses might tweak the existing algorithms, or might be used in conjunction with custom Query subclasses to implement arbitrary scoring schemes.</p>
-
-<p>Most of the methods operate on single fields, but some are used to combine scores from multiple fields.</p>
+<p>Most of the methods operate on single fields,
+but some are used to combine scores from multiple fields.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -108,9 +114,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $sim = Lucy::Index::Similarity->new;</pre>
+<pre>my $sim = Lucy::Index::Similarity->new;</pre>
-<p>Constructor. Takes no arguments.</p>
+<p>Constructor.
+Takes no arguments.</p>
<h2><a class='u'
name="METHODS"
@@ -120,15 +127,24 @@ name="METHODS"
name="length_norm"
>length_norm</a></h3>
-<pre> my $retval = $similarity->length_norm($num_tokens);</pre>
+<pre>my $retval = $similarity->length_norm($num_tokens);</pre>
<p>Dampen the scores of long documents.</p>
-<p>After a field is broken up into terms at index-time, each term must be assigned a weight. One of the factors in calculating this weight is the number of tokens that the original field was broken into.</p>
-
-<p>Typically, we assume that the more tokens in a field, the less important any one of them is – so that, e.g. 5 mentions of “Kafka” in a short article are given more heft than 5 mentions of “Kafka” in an entire book. The default implementation of length_norm expresses this using an inverted square root.</p>
-
-<p>However, the inverted square root has a tendency to reward very short fields highly, which isn’t always appropriate for fields you expect to have a lot of tokens on average.</p>
+<p>After a field is broken up into terms at index-time,
+each term must be assigned a weight.
+One of the factors in calculating this weight is the number of tokens that the original field was broken into.</p>
+
+<p>Typically,
+we assume that the more tokens in a field,
+the less important any one of them is – so that,
+e.g.
+5 mentions of “Kafka” in a short article are given more heft than 5 mentions of “Kafka” in an entire book.
+The default implementation of length_norm expresses this using an inverted square root.</p>
+
+<p>However,
+the inverted square root has a tendency to reward very short fields highly,
+which isn’t always appropriate for fields you expect to have a lot of tokens on average.</p>
<h2><a class='u'
name="INHERITANCE"
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Snapshot.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Snapshot.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Snapshot.html Fri Feb 26 13:44:48 2016
@@ -81,16 +81,20 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $snapshot = Lucy::Index::Snapshot->new;
- $snapshot->read_file( folder => $folder ); # load most recent snapshot
- my $files = $snapshot->list;
- print "$_\n" for @$files;</pre>
+<pre>my $snapshot = Lucy::Index::Snapshot->new;
+$snapshot->read_file( folder => $folder ); # load most recent snapshot
+my $files = $snapshot->list;
+print "$_\n" for @$files;</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>A Snapshot is list of index files and folders. Because index files, once written, are never modified, a Snapshot defines a point-in-time view of the data in an index.</p>
+<p>A Snapshot is list of index files and folders.
+Because index files,
+once written,
+are never modified,
+a Snapshot defines a point-in-time view of the data in an index.</p>
<p><a href="../../Lucy/Index/IndexReader.html" class="podlinkpod"
>IndexReader</a> objects interpret the data associated with a single Snapshot.</p>
@@ -103,9 +107,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $snapshot = Lucy::Index::Snapshot->new;</pre>
+<pre>my $snapshot = Lucy::Index::Snapshot->new;</pre>
-<p>Constructor. Takes no arguments.</p>
+<p>Constructor.
+Takes no arguments.</p>
<h2><a class='u'
name="METHODS"
@@ -115,7 +120,7 @@ name="METHODS"
name="list"
>list</a></h3>
-<pre> my $retval = $snapshot->list();</pre>
+<pre>my $retval = $snapshot->list();</pre>
<p>Return an array of all entries.</p>
@@ -123,7 +128,7 @@ name="list"
name="num_entries"
>num_entries</a></h3>
-<pre> my $retval = $snapshot->num_entries();</pre>
+<pre>my $retval = $snapshot->num_entries();</pre>
<p>Return the number of entries (including directories).</p>
@@ -131,7 +136,7 @@ name="num_entries"
name="add_entry"
>add_entry</a></h3>
-<pre> $snapshot->add_entry($entry);</pre>
+<pre>$snapshot->add_entry($entry);</pre>
<p>Add a filepath to the snapshot.</p>
@@ -139,27 +144,30 @@ name="add_entry"
name="delete_entry"
>delete_entry</a></h3>
-<pre> my $retval = $snapshot->delete_entry($entry);</pre>
+<pre>my $retval = $snapshot->delete_entry($entry);</pre>
<p>Delete a filepath from the snapshot.</p>
-<p>Returns: true if the entry existed and was successfully deleted, false otherwise.</p>
+<p>Returns: true if the entry existed and was successfully deleted,
+false otherwise.</p>
<h3><a class='u'
name="read_file"
>read_file</a></h3>
-<pre> my $retval = $snapshot->read_file(
- folder => $folder # required
- path => $path # default: undef
- );</pre>
+<pre>my $retval = $snapshot->read_file(
+ folder => $folder # required
+ path => $path # default: undef
+);</pre>
<p>Decode a snapshot file and initialize the object to reflect its contents.</p>
<ul>
<li><b>folder</b> - A Folder.</li>
-<li><b>path</b> - The location of the snapshot file. If not supplied, the most recent snapshot file in the base directory will be chosen.</li>
+<li><b>path</b> - The location of the snapshot file.
+If not supplied,
+the most recent snapshot file in the base directory will be chosen.</li>
</ul>
<p>Returns: the Snapshot object itself</p>
@@ -168,24 +176,28 @@ name="read_file"
name="write_file"
>write_file</a></h3>
-<pre> $snapshot->write_file(
- folder => $folder # required
- path => $path # default: undef
- );</pre>
-
-<p>Write a snapshot file. The caller must lock the index while this operation takes place, and the operation will fail if the snapshot file already exists.</p>
+<pre>$snapshot->write_file(
+ folder => $folder # required
+ path => $path # default: undef
+);</pre>
+
+<p>Write a snapshot file.
+The caller must lock the index while this operation takes place,
+and the operation will fail if the snapshot file already exists.</p>
<ul>
<li><b>folder</b> - A Folder.</li>
-<li><b>path</b> - The path of the file to write. If undef, a file name will be chosen which supersedes the latest snapshot file in the index folder.</li>
+<li><b>path</b> - The path of the file to write.
+If undef,
+a file name will be chosen which supersedes the latest snapshot file in the index folder.</li>
</ul>
<h3><a class='u'
name="set_path"
>set_path</a></h3>
-<pre> $snapshot->set_path($path);</pre>
+<pre>$snapshot->set_path($path);</pre>
<p>Set the path to the file that the Snapshot object serves as a proxy for.</p>
@@ -193,11 +205,14 @@ name="set_path"
name="get_path"
>get_path</a></h3>
-<pre> my $retval = $snapshot->get_path();</pre>
+<pre>my $retval = $snapshot->get_path();</pre>
-<p>Get the path to the snapshot file. Initially undef; updated by <a href="#read_file" class="podlinkpod"
->read_file()</a>, <a href="#write_file" class="podlinkpod"
->write_file()</a>, and <a href="#set_path" class="podlinkpod"
+<p>Get the path to the snapshot file.
+Initially undef; updated by <a href="#read_file" class="podlinkpod"
+>read_file()</a>,
+<a href="#write_file" class="podlinkpod"
+>write_file()</a>,
+and <a href="#set_path" class="podlinkpod"
>set_path()</a>.</p>
<h2><a class='u'
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Object/BitVector.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Object/BitVector.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Object/BitVector.html Fri Feb 26 13:44:48 2016
@@ -81,18 +81,19 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $bit_vec = Lucy::Object::BitVector->new( capacity => 8 );
- my $other = Lucy::Object::BitVector->new( capacity => 8 );
- $bit_vec->set($_) for ( 0, 2, 4, 6 );
- $other->set($_) for ( 1, 3, 5, 7 );
- $bit_vec->or($other);
- print "$_\n" for @{ $bit_vec->to_array }; # prints 0 through 7.</pre>
+<pre>my $bit_vec = Lucy::Object::BitVector->new( capacity => 8 );
+my $other = Lucy::Object::BitVector->new( capacity => 8 );
+$bit_vec->set($_) for ( 0, 2, 4, 6 );
+$other->set($_) for ( 1, 3, 5, 7 );
+$bit_vec->or($other);
+print "$_\n" for @{ $bit_vec->to_array }; # prints 0 through 7.</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>BitVector is a growable array of bits. All bits are initially zero.</p>
+<p>BitVector is a growable array of bits.
+All bits are initially zero.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -102,9 +103,9 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $bit_vec = Lucy::Object::BitVector->new(
- capacity => $doc_max + 1, # default 0,
- );</pre>
+<pre>my $bit_vec = Lucy::Object::BitVector->new(
+ capacity => $doc_max + 1, # default 0,
+);</pre>
<p>Create a new BitVector.</p>
@@ -120,9 +121,10 @@ name="METHODS"
name="get"
>get</a></h3>
-<pre> my $retval = $bit_vector->get($tick);</pre>
+<pre>my $retval = $bit_vector->get($tick);</pre>
-<p>Return true if the bit at <code>tick</code> has been set, false if it hasn’t (regardless of whether it lies within the bounds of the object’s capacity).</p>
+<p>Return true if the bit at <code>tick</code> has been set,
+false if it hasn’t (regardless of whether it lies within the bounds of the object’s capacity).</p>
<ul>
<li><b>tick</b> - The requested bit.</li>
@@ -132,7 +134,7 @@ name="get"
name="set"
>set</a></h3>
-<pre> $bit_vector->set($tick);</pre>
+<pre>$bit_vector->set($tick);</pre>
<p>Set the bit at <code>tick</code> to 1.</p>
@@ -144,17 +146,20 @@ name="set"
name="next_hit"
>next_hit</a></h3>
-<pre> my $retval = $bit_vector->next_hit($tick);</pre>
+<pre>my $retval = $bit_vector->next_hit($tick);</pre>
-<p>Returns the next set bit equal to or greater than <code>tick</code>, or -1 if no such bit exists.</p>
+<p>Returns the next set bit equal to or greater than <code>tick</code>,
+or -1 if no such bit exists.</p>
<h3><a class='u'
name="clear"
>clear</a></h3>
-<pre> $bit_vector->clear($tick);</pre>
+<pre>$bit_vector->clear($tick);</pre>
-<p>Clear the indicated bit. (i.e. set it to 0).</p>
+<p>Clear the indicated bit.
+(i.e.
+set it to 0).</p>
<ul>
<li><b>tick</b> - The bit to be cleared.</li>
@@ -164,7 +169,7 @@ name="clear"
name="clear_all"
>clear_all</a></h3>
-<pre> $bit_vector->clear_all();</pre>
+<pre>$bit_vector->clear_all();</pre>
<p>Clear all bits.</p>
@@ -172,9 +177,10 @@ name="clear_all"
name="grow"
>grow</a></h3>
-<pre> $bit_vector->grow($capacity);</pre>
+<pre>$bit_vector->grow($capacity);</pre>
-<p>If the BitVector does not already have enough room to hold the indicated number of bits, allocate more memory so that it can.</p>
+<p>If the BitVector does not already have enough room to hold the indicated number of bits,
+allocate more memory so that it can.</p>
<ul>
<li><b>capacity</b> - Least number of bits the BitVector should accomodate.</li>
@@ -184,9 +190,10 @@ name="grow"
name="and"
>and</a></h3>
-<pre> $bit_vector->and($other);</pre>
+<pre>$bit_vector->and($other);</pre>
-<p>Modify the BitVector so that only bits which remain set are those which 1) were already set in this BitVector, and 2) were also set in the other BitVector.</p>
+<p>Modify the BitVector so that only bits which remain set are those which 1) were already set in this BitVector,
+and 2) were also set in the other BitVector.</p>
<ul>
<li><b>other</b> - Another BitVector.</li>
@@ -196,9 +203,10 @@ name="and"
name="or"
>or</a></h3>
-<pre> $bit_vector->or($other);</pre>
+<pre>$bit_vector->or($other);</pre>
-<p>Modify the BitVector, setting all bits which are set in the other BitVector if they were not already set.</p>
+<p>Modify the BitVector,
+setting all bits which are set in the other BitVector if they were not already set.</p>
<ul>
<li><b>other</b> - Another BitVector.</li>
@@ -208,9 +216,10 @@ name="or"
name="xor"
>xor</a></h3>
-<pre> $bit_vector->xor($other);</pre>
+<pre>$bit_vector->xor($other);</pre>
-<p>Modify the BitVector, performing an XOR operation against the other.</p>
+<p>Modify the BitVector,
+performing an XOR operation against the other.</p>
<ul>
<li><b>other</b> - Another BitVector.</li>
@@ -220,9 +229,10 @@ name="xor"
name="and_not"
>and_not</a></h3>
-<pre> $bit_vector->and_not($other);</pre>
+<pre>$bit_vector->and_not($other);</pre>
-<p>Modify the BitVector, clearing all bits which are set in the other.</p>
+<p>Modify the BitVector,
+clearing all bits which are set in the other.</p>
<ul>
<li><b>other</b> - Another BitVector.</li>
@@ -232,7 +242,7 @@ name="and_not"
name="flip"
>flip</a></h3>
-<pre> $bit_vector->flip($tick);</pre>
+<pre>$bit_vector->flip($tick);</pre>
<p>Invert the value of a bit.</p>
@@ -244,10 +254,10 @@ name="flip"
name="flip_block"
>flip_block</a></h3>
-<pre> $bit_vector->flip_block(
- offset => $offset # required
- length => $length # required
- );</pre>
+<pre>$bit_vector->flip_block(
+ offset => $offset # required
+ length => $length # required
+);</pre>
<p>Invert each bit within a contiguous block.</p>
@@ -261,7 +271,7 @@ name="flip_block"
name="count"
>count</a></h3>
-<pre> my $retval = $bit_vector->count();</pre>
+<pre>my $retval = $bit_vector->count();</pre>
<p>Return a count of the number of set bits.</p>
@@ -269,7 +279,7 @@ name="count"
name="to_array"
>to_array</a></h3>
-<pre> my $retval = $bit_vector->to_array();</pre>
+<pre>my $retval = $bit_vector->to_array();</pre>
<p>Return an array where each element represents a set bit.</p>
@@ -277,7 +287,7 @@ name="to_array"
name="clone"
>clone</a></h3>
-<pre> my $retval = $bit_vector->clone();</pre>
+<pre>my $retval = $bit_vector->clone();</pre>
<p>Return a clone of the object.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Architecture.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Architecture.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Architecture.html Fri Feb 26 13:44:48 2016
@@ -81,54 +81,61 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> package MyArchitecture;
- use base qw( Lucy::Plan::Architecture );
+<pre>package MyArchitecture;
+use base qw( Lucy::Plan::Architecture );
- use LucyX::Index::ZlibDocWriter;
- use LucyX::Index::ZlibDocReader;
+use LucyX::Index::ZlibDocWriter;
+use LucyX::Index::ZlibDocReader;
- sub register_doc_writer {
- my ( $self, $seg_writer ) = @_;
- my $doc_writer = LucyX::Index::ZlibDocWriter->new(
- 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::ZlibDocReader->new(
- 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 {
- shift;
- return MyArchitecture->new(@_);
- }</pre>
+sub register_doc_writer {
+ my ( $self, $seg_writer ) = @_;
+ my $doc_writer = LucyX::Index::ZlibDocWriter->new(
+ 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::ZlibDocReader->new(
+ 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 {
+ shift;
+ return MyArchitecture->new(@_);
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>By default, a Lucy index consists of several main parts: lexicon, postings, stored documents, deletions, and highlight data. The readers and writers for that data are spawned by Architecture. Each component operates at the segment level; Architecture’s factory methods are used to build up <a href="../../Lucy/Index/SegWriter.html" class="podlinkpod"
+<p>By default,
+a Lucy index consists of several main parts: lexicon,
+postings,
+stored documents,
+deletions,
+and highlight data.
+The readers and writers for that data are spawned by Architecture.
+Each component operates at the segment level; Architecture’s factory methods are used to build up <a href="../../Lucy/Index/SegWriter.html" class="podlinkpod"
>SegWriter</a> and <a href="../../Lucy/Index/SegReader.html" class="podlinkpod"
>SegReader</a>.</p>
@@ -140,9 +147,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $arch = Lucy::Plan::Architecture->new;</pre>
+<pre>my $arch = Lucy::Plan::Architecture->new;</pre>
-<p>Constructor. Takes no arguments.</p>
+<p>Constructor.
+Takes no arguments.</p>
<h2><a class='u'
name="METHODS"
@@ -152,10 +160,11 @@ name="METHODS"
name="register_doc_writer"
>register_doc_writer</a></h3>
-<pre> $architecture->register_doc_writer($writer);</pre>
+<pre>$architecture->register_doc_writer($writer);</pre>
<p>Spawn a DataWriter and <a href="../../Lucy/Index/SegWriter.html#register" class="podlinkpod"
->register()</a> it with the supplied SegWriter, adding it to the SegWriter’s writer stack.</p>
+>register()</a> it with the supplied SegWriter,
+adding it to the SegWriter’s writer stack.</p>
<ul>
<li><b>writer</b> - A SegWriter.</li>
@@ -165,7 +174,7 @@ name="register_doc_writer"
name="register_doc_reader"
>register_doc_reader</a></h3>
-<pre> $architecture->register_doc_reader($reader);</pre>
+<pre>$architecture->register_doc_reader($reader);</pre>
<p>Spawn a DocReader and register it with the supplied SegReader.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/BlobType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/BlobType.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/BlobType.html Fri Feb 26 13:44:48 2016
@@ -81,17 +81,18 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $string_type = Lucy::Plan::StringType->new;
- my $blob_type = Lucy::Plan::BlobType->new( stored => 1 );
- my $schema = Lucy::Plan::Schema->new;
- $schema->spec_field( name => 'id', type => $string_type );
- $schema->spec_field( name => 'jpeg', type => $blob_type );</pre>
+<pre>my $string_type = Lucy::Plan::StringType->new;
+my $blob_type = Lucy::Plan::BlobType->new( stored => 1 );
+my $schema = Lucy::Plan::Schema->new;
+$schema->spec_field( name => 'id', type => $string_type );
+$schema->spec_field( name => 'jpeg', type => $blob_type );</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>BlobType is an implementation of FieldType tuned for use with fields containing binary data, which cannot be indexed or searched – only stored.</p>
+<p>BlobType is an implementation of FieldType tuned for use with fields containing binary data,
+which cannot be indexed or searched – only stored.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -101,9 +102,9 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $blob_type = Lucy::Plan::BlobType->new(
- stored => 1, # default: false
- );</pre>
+<pre>my $blob_type = Lucy::Plan::BlobType->new(
+ stored => 1, # default: false
+);</pre>
<p>Create a new BlobType.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FieldType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FieldType.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FieldType.html Fri Feb 26 13:44:48 2016
@@ -81,12 +81,12 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my @sortable;
- for my $field ( @{ $schema->all_fields } ) {
- my $type = $schema->fetch_type($field);
- next unless $type->sortable;
- push @sortable, $field;
- }</pre>
+<pre>my @sortable;
+for my $field ( @{ $schema->all_fields } ) {
+ my $type = $schema->fetch_type($field);
+ next unless $type->sortable;
+ push @sortable, $field;
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -94,20 +94,32 @@ name="DESCRIPTION"
<p>FieldType is an abstract class defining a set of traits and behaviors which may be associated with one or more field names.</p>
-<p>Properties which are common to all field types include <code>boost</code>, <code>indexed</code>, <code>stored</code>, <code>sortable</code>, <code>binary</code>, and <code>similarity</code>.</p>
-
-<p>The <code>boost</code> property is a floating point scoring multiplier which defaults to 1.0. Values greater than 1.0 cause the field to contribute more to a document’s score, lower values, less.</p>
+<p>Properties which are common to all field types include <code>boost</code>,
+<code>indexed</code>,
+<code>stored</code>,
+<code>sortable</code>,
+<code>binary</code>,
+and <code>similarity</code>.</p>
+
+<p>The <code>boost</code> property is a floating point scoring multiplier which defaults to 1.0.
+Values greater than 1.0 cause the field to contribute more to a document’s score,
+lower values,
+less.</p>
<p>The <code>indexed</code> property indicates whether the field should be indexed (so that it can be searched).</p>
-<p>The <code>stored</code> property indicates whether to store the raw field value, so that it can be retrieved when a document turns up in a search.</p>
+<p>The <code>stored</code> property indicates whether to store the raw field value,
+so that it can be retrieved when a document turns up in a search.</p>
<p>The <code>sortable</code> property indicates whether search results should be sortable based on the contents of the field.</p>
-<p>The <code>binary</code> property indicates whether the field contains binary or text data. Unlike most other properties, <code>binary</code> is not settable.</p>
+<p>The <code>binary</code> property indicates whether the field contains binary or text data.
+Unlike most other properties,
+<code>binary</code> is not settable.</p>
<p>The <code>similarity</code> property is a <a href="../../Lucy/Index/Similarity.html" class="podlinkpod"
->Similarity</a> object which defines matching and scoring behavior for the field. It is required if the field is <code>indexed</code>.</p>
+>Similarity</a> object which defines matching and scoring behavior for the field.
+It is required if the field is <code>indexed</code>.</p>
<h2><a class='u'
name="METHODS"
@@ -117,7 +129,7 @@ name="METHODS"
name="set_boost"
>set_boost</a></h3>
-<pre> $field_type->set_boost($boost);</pre>
+<pre>$field_type->set_boost($boost);</pre>
<p>Setter for <code>boost</code>.</p>
@@ -125,7 +137,7 @@ name="set_boost"
name="get_boost"
>get_boost</a></h3>
-<pre> my $retval = $field_type->get_boost();</pre>
+<pre>my $retval = $field_type->get_boost();</pre>
<p>Accessor for <code>boost</code>.</p>
@@ -133,7 +145,7 @@ name="get_boost"
name="set_indexed"
>set_indexed</a></h3>
-<pre> $field_type->set_indexed($indexed);</pre>
+<pre>$field_type->set_indexed($indexed);</pre>
<p>Setter for <code>indexed</code>.</p>
@@ -141,7 +153,7 @@ name="set_indexed"
name="indexed"
>indexed</a></h3>
-<pre> my $retval = $field_type->indexed();</pre>
+<pre>my $retval = $field_type->indexed();</pre>
<p>Accessor for <code>indexed</code>.</p>
@@ -149,7 +161,7 @@ name="indexed"
name="set_stored"
>set_stored</a></h3>
-<pre> $field_type->set_stored($stored);</pre>
+<pre>$field_type->set_stored($stored);</pre>
<p>Setter for <code>stored</code>.</p>
@@ -157,7 +169,7 @@ name="set_stored"
name="stored"
>stored</a></h3>
-<pre> my $retval = $field_type->stored();</pre>
+<pre>my $retval = $field_type->stored();</pre>
<p>Accessor for <code>stored</code>.</p>
@@ -165,7 +177,7 @@ name="stored"
name="set_sortable"
>set_sortable</a></h3>
-<pre> $field_type->set_sortable($sortable);</pre>
+<pre>$field_type->set_sortable($sortable);</pre>
<p>Setter for <code>sortable</code>.</p>
@@ -173,7 +185,7 @@ name="set_sortable"
name="sortable"
>sortable</a></h3>
-<pre> my $retval = $field_type->sortable();</pre>
+<pre>my $retval = $field_type->sortable();</pre>
<p>Accessor for <code>sortable</code>.</p>
@@ -181,7 +193,7 @@ name="sortable"
name="binary"
>binary</a></h3>
-<pre> my $retval = $field_type->binary();</pre>
+<pre>my $retval = $field_type->binary();</pre>
<p>Indicate whether the field contains binary data.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FullTextType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FullTextType.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FullTextType.html Fri Feb 26 13:44:48 2016
@@ -81,15 +81,15 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $easyanalyzer = Lucy::Analysis::EasyAnalyzer->new(
- language => 'en',
- );
- my $type = Lucy::Plan::FullTextType->new(
- analyzer => $easyanalyzer,
- );
- my $schema = Lucy::Plan::Schema->new;
- $schema->spec_field( name => 'title', type => $type );
- $schema->spec_field( name => 'content', type => $type );</pre>
+<pre>my $easyanalyzer = Lucy::Analysis::EasyAnalyzer->new(
+ language => 'en',
+);
+my $type = Lucy::Plan::FullTextType->new(
+ analyzer => $easyanalyzer,
+);
+my $schema = Lucy::Plan::Schema->new;
+$schema->spec_field( name => 'title', type => $type );
+$schema->spec_field( name => 'content', type => $type );</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -99,9 +99,12 @@ name="DESCRIPTION"
>FieldType</a> tuned for “full text search”.</p>
<p>Full text fields are associated with an <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod"
->Analyzer</a>, which is used to tokenize and normalize the text so that it can be searched for individual words.</p>
+>Analyzer</a>,
+which is used to tokenize and normalize the text so that it can be searched for individual words.</p>
-<p>For an exact-match, single value field type using character data, see <a href="../../Lucy/Plan/StringType.html" class="podlinkpod"
+<p>For an exact-match,
+single value field type using character data,
+see <a href="../../Lucy/Plan/StringType.html" class="podlinkpod"
>StringType</a>.</p>
<h2><a class='u'
@@ -112,14 +115,14 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $type = Lucy::Plan::FullTextType->new(
- analyzer => $analyzer, # required
- boost => 2.0, # default: 1.0
- indexed => 1, # default: true
- stored => 1, # default: true
- sortable => 1, # default: false
- highlightable => 1, # default: false
- );</pre>
+<pre>my $type = Lucy::Plan::FullTextType->new(
+ analyzer => $analyzer, # required
+ boost => 2.0, # default: 1.0
+ indexed => 1, # default: true
+ stored => 1, # default: true
+ sortable => 1, # default: false
+ highlightable => 1, # default: false
+);</pre>
<ul>
<li><b>analyzer</b> - An Analyzer.</li>
@@ -143,7 +146,7 @@ name="METHODS"
name="set_highlightable"
>set_highlightable</a></h3>
-<pre> $full_text_type->set_highlightable($highlightable);</pre>
+<pre>$full_text_type->set_highlightable($highlightable);</pre>
<p>Indicate whether to store data required by <a href="../../Lucy/Highlight/Highlighter.html" class="podlinkpod"
>Highlighter</a> for excerpt selection and search term highlighting.</p>
@@ -152,7 +155,7 @@ name="set_highlightable"
name="highlightable"
>highlightable</a></h3>
-<pre> my $retval = $full_text_type->highlightable();</pre>
+<pre>my $retval = $full_text_type->highlightable();</pre>
<p>Accessor for “highlightable” property.</p>
@@ -160,7 +163,7 @@ name="highlightable"
name="get_analyzer"
>get_analyzer</a></h3>
-<pre> my $retval = $full_text_type->get_analyzer();</pre>
+<pre>my $retval = $full_text_type->get_analyzer();</pre>
<p>Accessor for the type’s analyzer.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Schema.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Schema.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Schema.html Fri Feb 26 13:44:48 2016
@@ -81,19 +81,19 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> use Lucy::Plan::Schema;
- use Lucy::Plan::FullTextType;
- use Lucy::Analysis::EasyAnalyzer;
-
- my $schema = Lucy::Plan::Schema->new;
- my $easyanalyzer = Lucy::Analysis::EasyAnalyzer->new(
- language => 'en',
- );
- my $type = Lucy::Plan::FullTextType->new(
- analyzer => $easyanalyzer,
- );
- $schema->spec_field( name => 'title', type => $type );
- $schema->spec_field( name => 'content', type => $type );</pre>
+<pre>use Lucy::Plan::Schema;
+use Lucy::Plan::FullTextType;
+use Lucy::Analysis::EasyAnalyzer;
+
+my $schema = Lucy::Plan::Schema->new;
+my $easyanalyzer = Lucy::Analysis::EasyAnalyzer->new(
+ language => 'en',
+);
+my $type = Lucy::Plan::FullTextType->new(
+ analyzer => $easyanalyzer,
+);
+$schema->spec_field( name => 'title', type => $type );
+$schema->spec_field( name => 'content', type => $type );</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -101,7 +101,10 @@ name="DESCRIPTION"
<p>A Schema is a specification which indicates how other entities should interpret the raw data in an inverted index and interact with it.</p>
-<p>Once an actual index has been created using a particular Schema, existing field definitions may not be changed. However, it is possible to add new fields during subsequent indexing sessions.</p>
+<p>Once an actual index has been created using a particular Schema,
+existing field definitions may not be changed.
+However,
+it is possible to add new fields during subsequent indexing sessions.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -111,9 +114,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $schema = Lucy::Plan::Schema->new;</pre>
+<pre>my $schema = Lucy::Plan::Schema->new;</pre>
-<p>Constructor. Takes no arguments.</p>
+<p>Constructor.
+Takes no arguments.</p>
<h2><a class='u'
name="METHODS"
@@ -123,7 +127,7 @@ name="METHODS"
name="architecture"
>architecture</a></h3>
-<pre> my $retval = $schema->architecture();</pre>
+<pre>my $retval = $schema->architecture();</pre>
<p>Factory method which creates an Architecture object for this index.</p>
@@ -131,14 +135,15 @@ name="architecture"
name="spec_field"
>spec_field</a></h3>
-<pre> $schema->spec_field(
- name => $name # required
- type => $type # required
- );</pre>
+<pre>$schema->spec_field(
+ name => $name # required
+ type => $type # required
+);</pre>
<p>Define the behavior of a field by associating it with a FieldType.</p>
-<p>If this method has already been called for the supplied <code>field</code>, it will merely test to verify that the supplied FieldType <a href="../../Clownfish/Obj.html#equals" class="podlinkpod"
+<p>If this method has already been called for the supplied <code>field</code>,
+it will merely test to verify that the supplied FieldType <a href="../../Clownfish/Obj.html#equals" class="podlinkpod"
>equals()</a> the existing one.</p>
<ul>
@@ -151,24 +156,27 @@ name="spec_field"
name="fetch_type"
>fetch_type</a></h3>
-<pre> my $retval = $schema->fetch_type($field);</pre>
+<pre>my $retval = $schema->fetch_type($field);</pre>
-<p>Return the FieldType for the specified field. If the field can’t be found, return undef.</p>
+<p>Return the FieldType for the specified field.
+If the field can’t be found,
+return undef.</p>
<h3><a class='u'
name="fetch_sim"
>fetch_sim</a></h3>
-<pre> my $retval = $schema->fetch_sim($field);
- my $retval = $schema->fetch_sim(); # default: undef</pre>
+<pre>my $retval = $schema->fetch_sim($field);
+my $retval = $schema->fetch_sim(); # default: undef</pre>
-<p>Return the Similarity for the specified field, or undef if either the field can’t be found or it isn’t associated with a Similarity.</p>
+<p>Return the Similarity for the specified field,
+or undef if either the field can’t be found or it isn’t associated with a Similarity.</p>
<h3><a class='u'
name="num_fields"
>num_fields</a></h3>
-<pre> my $retval = $schema->num_fields();</pre>
+<pre>my $retval = $schema->num_fields();</pre>
<p>Return the number of fields currently defined.</p>
@@ -176,7 +184,7 @@ name="num_fields"
name="all_fields"
>all_fields</a></h3>
-<pre> my $retval = $schema->all_fields();</pre>
+<pre>my $retval = $schema->all_fields();</pre>
<p>Return all the Schema’s field names as an array.</p>
@@ -184,7 +192,7 @@ name="all_fields"
name="get_architecture"
>get_architecture</a></h3>
-<pre> my $retval = $schema->get_architecture();</pre>
+<pre>my $retval = $schema->get_architecture();</pre>
<p>Return the Schema instance’s internal Architecture object.</p>
@@ -192,7 +200,7 @@ name="get_architecture"
name="get_similarity"
>get_similarity</a></h3>
-<pre> my $retval = $schema->get_similarity();</pre>
+<pre>my $retval = $schema->get_similarity();</pre>
<p>Return the Schema instance’s internal Similarity object.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/StringType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/StringType.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/StringType.html Fri Feb 26 13:44:48 2016
@@ -81,9 +81,9 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $type = Lucy::Plan::StringType->new;
- my $schema = Lucy::Plan::Schema->new;
- $schema->spec_field( name => 'category', type => $type );</pre>
+<pre>my $type = Lucy::Plan::StringType->new;
+my $schema = Lucy::Plan::Schema->new;
+$schema->spec_field( name => 'category', type => $type );</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -99,12 +99,12 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $type = Lucy::Plan::StringType->new(
- boost => 0.1, # default: 1.0
- indexed => 1, # default: true
- stored => 1, # default: true
- sortable => 1, # default: false
- );</pre>
+<pre>my $type = Lucy::Plan::StringType->new(
+ boost => 0.1, # default: 1.0
+ indexed => 1, # default: true
+ stored => 1, # default: true
+ sortable => 1, # default: false
+);</pre>
<ul>
<li><b>boost</b> - floating point per-field boost.</li>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/ANDQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/ANDQuery.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/ANDQuery.html Fri Feb 26 13:44:48 2016
@@ -81,18 +81,20 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $foo_and_bar_query = Lucy::Search::ANDQuery->new(
- children => [ $foo_query, $bar_query ],
- );
- my $hits = $searcher->hits( query => $foo_and_bar_query );
- ...</pre>
+<pre>my $foo_and_bar_query = Lucy::Search::ANDQuery->new(
+ children => [ $foo_query, $bar_query ],
+);
+my $hits = $searcher->hits( query => $foo_and_bar_query );
+...</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
<p>ANDQuery is a composite <a href="../../Lucy/Search/Query.html" class="podlinkpod"
->Query</a> which matches only when all of its children match, so its result set is the intersection of their result sets. Documents which match receive a summed score.</p>
+>Query</a> which matches only when all of its children match,
+so its result set is the intersection of their result sets.
+Documents which match receive a summed score.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -102,9 +104,9 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $foo_and_bar_query = Lucy::Search::ANDQuery->new(
- children => [ $foo_query, $bar_query ],
- );</pre>
+<pre>my $foo_and_bar_query = Lucy::Search::ANDQuery->new(
+ children => [ $foo_query, $bar_query ],
+);</pre>
<p>Create a new ANDQuery.</p>
@@ -120,11 +122,11 @@ name="METHODS"
name="make_compiler"
>make_compiler</a></h3>
-<pre> my $retval = $and_query->make_compiler(
- searcher => $searcher # required
- boost => $boost # required
- subordinate => $subordinate # default: false
- );</pre>
+<pre>my $retval = $and_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>
@@ -133,7 +135,9 @@ name="make_compiler"
<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"
+<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>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector.html Fri Feb 26 13:44:48 2016
@@ -81,17 +81,23 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> # Abstract base class.</pre>
+<pre># Abstract base class.</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
<p>A Collector decides what to do with the hits that a <a href="../../Lucy/Search/Matcher.html" class="podlinkpod"
->Matcher</a> iterates through, based on how the abstract <a href="#collect" class="podlinkpod"
+>Matcher</a> iterates through,
+based on how the abstract <a href="#collect" class="podlinkpod"
>collect()</a> method is implemented.</p>
-<p>Collectors operate on individual segments, but must operate within the context of a larger collection. Each time the collector moves to a new segment, Set_Reader(), Set_Base() and Set_Matcher() will be called, and the collector must take the updated information into account.</p>
+<p>Collectors operate on individual segments,
+but must operate within the context of a larger collection.
+Each time the collector moves to a new segment,
+Set_Reader(),
+Set_Base() and Set_Matcher() will be called,
+and the collector must take the updated information into account.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -101,17 +107,18 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> package MyCollector;
- use base qw( Lucy::Search::Collector );
- our %foo;
- sub new {
- my $self = shift->SUPER::new;
- my %args = @_;
- $foo{$$self} = $args{foo};
- return $self;
- }</pre>
+<pre>package MyCollector;
+use base qw( Lucy::Search::Collector );
+our %foo;
+sub new {
+ my $self = shift->SUPER::new;
+ my %args = @_;
+ $foo{$$self} = $args{foo};
+ return $self;
+}</pre>
-<p>Abstract constructor. Takes no arguments.</p>
+<p>Abstract constructor.
+Takes no arguments.</p>
<h2><a class='u'
name="ABSTRACT_METHODS"
@@ -121,9 +128,11 @@ name="ABSTRACT_METHODS"
name="collect"
>collect</a></h3>
-<pre> $collector->collect($doc_id);</pre>
+<pre>$collector->collect($doc_id);</pre>
-<p>Do something with a doc id. (For instance, keep track of the docs with the ten highest scores.)</p>
+<p>Do something with a doc id.
+(For instance,
+keep track of the docs with the ten highest scores.)</p>
<ul>
<li><b>doc_id</b> - A segment document id.</li>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector/BitCollector.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector/BitCollector.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector/BitCollector.html Fri Feb 26 13:44:48 2016
@@ -81,23 +81,24 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $bit_vec = Lucy::Object::BitVector->new(
- capacity => $searcher->doc_max + 1,
- );
- my $bit_collector = Lucy::Search::Collector::BitCollector->new(
- bit_vector => $bit_vec,
- );
- $searcher->collect(
- collector => $bit_collector,
- query => $query,
- );</pre>
+<pre>my $bit_vec = Lucy::Object::BitVector->new(
+ capacity => $searcher->doc_max + 1,
+);
+my $bit_collector = Lucy::Search::Collector::BitCollector->new(
+ bit_vector => $bit_vec,
+);
+$searcher->collect(
+ collector => $bit_collector,
+ query => $query,
+);</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
<p>BitCollector is a Collector which saves matching document ids in a <a href="../../../Lucy/Object/BitVector.html" class="podlinkpod"
->BitVector</a>. It is useful for recording the entire set of documents which matches a query.</p>
+>BitVector</a>.
+It is useful for recording the entire set of documents which matches a query.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -107,9 +108,9 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $bit_collector = Lucy::Search::Collector::BitCollector->new(
- bit_vector => $bit_vec, # required
- );</pre>
+<pre>my $bit_collector = Lucy::Search::Collector::BitCollector->new(
+ bit_vector => $bit_vec, # required
+);</pre>
<p>Create a new BitCollector.</p>
@@ -125,7 +126,7 @@ name="METHODS"
name="collect"
>collect</a></h3>
-<pre> $bit_collector->collect($doc_id);</pre>
+<pre>$bit_collector->collect($doc_id);</pre>
<p>Set bit in the object’s BitVector for the supplied doc id.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Compiler.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Compiler.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Compiler.html Fri Feb 26 13:44:48 2016
@@ -81,14 +81,14 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> # (Compiler is an abstract base class.)
- package MyCompiler;
- use base qw( Lucy::Search::Compiler );
-
- sub make_matcher {
- my $self = shift;
- return MyMatcher->new( @_, compiler => $self );
- }</pre>
+<pre># (Compiler is an abstract base class.)
+package MyCompiler;
+use base qw( Lucy::Search::Compiler );
+
+sub make_matcher {
+ my $self = shift;
+ return MyMatcher->new( @_, compiler => $self );
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -101,19 +101,34 @@ name="DESCRIPTION"
<p>The simplest Compiler subclasses – such as those associated with constant-scoring Query types – might simply implement a <a href="#make_matcher" class="podlinkpod"
>make_matcher()</a> method which passes along information verbatim from the Query to the Matcher’s constructor.</p>
-<p>However it is common for the Compiler to perform some calculations which affect it’s “weight” – a floating point multiplier that the Matcher will factor into each document’s score. If that is the case, then the Compiler subclass may wish to override <a href="#get_weight" class="podlinkpod"
->get_weight()</a>, <a href="#sum_of_squared_weights" class="podlinkpod"
->sum_of_squared_weights()</a>, and <a href="#apply_norm_factor" class="podlinkpod"
+<p>However it is common for the Compiler to perform some calculations which affect it’s “weight” – a floating point multiplier that the Matcher will factor into each document’s score.
+If that is the case,
+then the Compiler subclass may wish to override <a href="#get_weight" class="podlinkpod"
+>get_weight()</a>,
+<a href="#sum_of_squared_weights" class="podlinkpod"
+>sum_of_squared_weights()</a>,
+and <a href="#apply_norm_factor" class="podlinkpod"
>apply_norm_factor()</a>.</p>
<p>Compiling a Matcher is a two stage process.</p>
-<p>The first stage takes place during the Compiler’s construction, which is where the Query object meets a <a href="../../Lucy/Search/Searcher.html" class="podlinkpod"
->Searcher</a> object for the first time. Searchers operate on a specific document collection and they can tell you certain statistical information about the collection – such as how many total documents are in the collection, or how many documents in the collection a particular term is present in. Lucy’s core Compiler classes plug this information into the classic TF/IDF weighting algorithm to adjust the Compiler’s weight; custom subclasses might do something similar.</p>
+<p>The first stage takes place during the Compiler’s construction,
+which is where the Query object meets a <a href="../../Lucy/Search/Searcher.html" class="podlinkpod"
+>Searcher</a> object for the first time.
+Searchers operate on a specific document collection and they can tell you certain statistical information about the collection – such as how many total documents are in the collection,
+or how many documents in the collection a particular term is present in.
+Lucy’s core Compiler classes plug this information into the classic TF/IDF weighting algorithm to adjust the Compiler’s weight; custom subclasses might do something similar.</p>
<p>The second stage of compilation is <a href="#make_matcher" class="podlinkpod"
->make_matcher()</a>, method, which is where the Compiler meets a <a href="../../Lucy/Index/SegReader.html" class="podlinkpod"
->SegReader</a> object. SegReaders are associated with a single segment within a single index on a single machine, and are thus lower-level than Searchers, which may represent a document collection spread out over a search cluster (comprising several indexes and many segments). The Compiler object can use new information supplied by the SegReader – such as whether a term is missing from the local index even though it is present within the larger collection represented by the Searcher – when figuring out what to feed to the Matchers’s constructor, or whether <a href="#make_matcher" class="podlinkpod"
+>make_matcher()</a>,
+method,
+which is where the Compiler meets a <a href="../../Lucy/Index/SegReader.html" class="podlinkpod"
+>SegReader</a> object.
+SegReaders are associated with a single segment within a single index on a single machine,
+and are thus lower-level than Searchers,
+which may represent a document collection spread out over a search cluster (comprising several indexes and many segments).
+The Compiler object can use new information supplied by the SegReader – such as whether a term is missing from the local index even though it is present within the larger collection represented by the Searcher – when figuring out what to feed to the Matchers’s constructor,
+or whether <a href="#make_matcher" class="podlinkpod"
>make_matcher()</a> should return a Matcher at all.</p>
<h2><a class='u'
@@ -124,23 +139,25 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $compiler = MyCompiler->SUPER::new(
- parent => $my_query,
- searcher => $searcher,
- similarity => $sim, # default: undef
- boost => undef, # default: see below
- );</pre>
+<pre>my $compiler = MyCompiler->SUPER::new(
+ parent => $my_query,
+ searcher => $searcher,
+ similarity => $sim, # default: undef
+ boost => undef, # default: see below
+);</pre>
<p>Abstract constructor.</p>
<ul>
<li><b>parent</b> - The parent Query.</li>
-<li><b>searcher</b> - A Lucy::Search::Searcher, such as an IndexSearcher.</li>
+<li><b>searcher</b> - A Lucy::Search::Searcher,
+such as an IndexSearcher.</li>
<li><b>similarity</b> - A Similarity.</li>
-<li><b>boost</b> - An arbitrary scoring multiplier. Defaults to the boost of the parent Query.</li>
+<li><b>boost</b> - An arbitrary scoring multiplier.
+Defaults to the boost of the parent Query.</li>
</ul>
<h2><a class='u'
@@ -151,10 +168,10 @@ name="ABSTRACT_METHODS"
name="make_matcher"
>make_matcher</a></h3>
-<pre> my $retval = $compiler->make_matcher(
- reader => $reader # required
- need_score => $need_score # required
- );</pre>
+<pre>my $retval = $compiler->make_matcher(
+ reader => $reader # required
+ need_score => $need_score # required
+);</pre>
<p>Factory method returning a Matcher.</p>
@@ -165,7 +182,8 @@ name="make_matcher"
>score()</a>.</li>
</ul>
-<p>Returns: a Matcher, or undef if the Matcher would have matched no documents.</p>
+<p>Returns: a Matcher,
+or undef if the Matcher would have matched no documents.</p>
<h2><a class='u'
name="METHODS"
@@ -175,15 +193,18 @@ name="METHODS"
name="get_weight"
>get_weight</a></h3>
-<pre> my $retval = $compiler->get_weight();</pre>
+<pre>my $retval = $compiler->get_weight();</pre>
-<p>Return the Compiler’s numerical weight, a scoring multiplier. By default, returns the object’s boost.</p>
+<p>Return the Compiler’s numerical weight,
+a scoring multiplier.
+By default,
+returns the object’s boost.</p>
<h3><a class='u'
name="get_similarity"
>get_similarity</a></h3>
-<pre> my $retval = $compiler->get_similarity();</pre>
+<pre>my $retval = $compiler->get_similarity();</pre>
<p>Accessor for the Compiler’s Similarity object.</p>
@@ -191,7 +212,7 @@ name="get_similarity"
name="get_parent"
>get_parent</a></h3>
-<pre> my $retval = $compiler->get_parent();</pre>
+<pre>my $retval = $compiler->get_parent();</pre>
<p>Accessor for the Compiler’s parent Query object.</p>
@@ -199,18 +220,23 @@ name="get_parent"
name="sum_of_squared_weights"
>sum_of_squared_weights</a></h3>
-<pre> my $retval = $compiler->sum_of_squared_weights();</pre>
+<pre>my $retval = $compiler->sum_of_squared_weights();</pre>
-<p>Compute and return a raw weighting factor. (This quantity is used by <a href="#normalize" class="podlinkpod"
->normalize()</a>). By default, simply returns 1.0.</p>
+<p>Compute and return a raw weighting factor.
+(This quantity is used by <a href="#normalize" class="podlinkpod"
+>normalize()</a>).
+By default,
+simply returns 1.0.</p>
<h3><a class='u'
name="apply_norm_factor"
>apply_norm_factor</a></h3>
-<pre> $compiler->apply_norm_factor($factor);</pre>
+<pre>$compiler->apply_norm_factor($factor);</pre>
-<p>Apply a floating point normalization multiplier. For a TermCompiler, this involves multiplying its own weight by the supplied factor; combining classes such as ORCompiler would apply the factor recursively to their children.</p>
+<p>Apply a floating point normalization multiplier.
+For a TermCompiler,
+this involves multiplying its own weight by the supplied factor; combining classes such as ORCompiler would apply the factor recursively to their children.</p>
<p>The default implementation is a no-op; subclasses may wish to multiply their internal weight by the supplied factor.</p>
@@ -222,17 +248,20 @@ name="apply_norm_factor"
name="normalize"
>normalize</a></h3>
-<pre> $compiler->normalize();</pre>
+<pre>$compiler->normalize();</pre>
-<p>Take a newly minted Compiler object and apply query-specific normalization factors. Should be invoked by Query subclasses during <a href="../../Lucy/Search/Query.html#make_compiler" class="podlinkpod"
+<p>Take a newly minted Compiler object and apply query-specific normalization factors.
+Should be invoked by Query subclasses during <a href="../../Lucy/Search/Query.html#make_compiler" class="podlinkpod"
>make_compiler()</a> for top-level nodes.</p>
-<p>For a TermQuery, the scoring formula is approximately:</p>
+<p>For a TermQuery,
+the scoring formula is approximately:</p>
-<pre> (tf_d * idf_t / norm_d) * (tf_q * idf_t / norm_q)</pre>
+<pre>(tf_d * idf_t / norm_d) * (tf_q * idf_t / norm_q)</pre>
<p><a href="#normalize" class="podlinkpod"
->normalize()</a> is theoretically concerned with applying the second half of that formula to a the Compiler’s weight. What actually happens depends on how the Compiler and Similarity methods called internally are implemented.</p>
+>normalize()</a> is theoretically concerned with applying the second half of that formula to a the Compiler’s weight.
+What actually happens depends on how the Compiler and Similarity methods called internally are implemented.</p>
<h2><a class='u'
name="INHERITANCE"
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Hits.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Hits.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Hits.html Fri Feb 26 13:44:48 2016
@@ -81,14 +81,14 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $hits = $searcher->hits(
- query => $query,
- offset => 0,
- num_wanted => 10,
- );
- while ( my $hit = $hits->next ) {
- print "<p>$hit->{title} <em>" . $hit->get_score . "</em></p>\n";
- }</pre>
+<pre>my $hits = $searcher->hits(
+ query => $query,
+ offset => 0,
+ num_wanted => 10,
+);
+while ( my $hit = $hits->next ) {
+ print "<p>$hit->{title} <em>" . $hit->get_score . "</em></p>\n";
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -104,17 +104,20 @@ name="METHODS"
name="next"
>next</a></h3>
-<pre> my $retval = $hits->next();</pre>
+<pre>my $retval = $hits->next();</pre>
-<p>Return the next hit, or undef when the iterator is exhausted.</p>
+<p>Return the next hit,
+or undef when the iterator is exhausted.</p>
<h3><a class='u'
name="total_hits"
>total_hits</a></h3>
-<pre> my $retval = $hits->total_hits();</pre>
+<pre>my $retval = $hits->total_hits();</pre>
-<p>Return the total number of documents which matched the Query used to produce the Hits object. Note that this is the total number of matches, not just the number of matches represented by the Hits iterator.</p>
+<p>Return the total number of documents which matched the Query used to produce the Hits object.
+Note that this is the total number of matches,
+not just the number of matches represented by the Hits iterator.</p>
<h2><a class='u'
name="INHERITANCE"