NAME

Search::InvertedIndex::Result - A list of result entries from a inverted index search.

SYNOPSIS

DESCRIPTION

Contains zero or more result entries from a search. Provides access methods to information in/from/about the entries.

CHANGES

1.00 1999.6.16 - Initial release

1.01 1999.6.17 - Documentation fixes

Public API

Initialization

new($parm_ref);

number_of_index_entries;

Returns the number of index entries in the result.

entry($parm_ref);

In an array context, returns the index, data and ranking for the requested entry.

In a scalar context returns only the index.

Examples:

my $index = $result->entry({ -number => 10 };

my ($index,$data,$ranking) = $result->entry({ -number => 10 });

COPYRIGHT

Copyright 1999, Benjamin Franz (<URL:http://www.nihongo.org/snowhare/>) and FreeRun Technologies, Inc. (<URL:http://www.freeruntech.com/>). All Rights Reserved. This software may be copied or redistributed under the same terms as Perl itelf.

AUTHOR

Benjamin Franz

TODO

Everything.