NAME

WARC::Index::Entry - abstract base class for WARC::Index entries

SYNOPSIS

use WARC;		# or ...
use WARC::Index;

# WARC::Index::Entry objects are returned from directly searching an index

DESCRIPTION

Methods

@report = $entry->distance( ... )

$distance = $entry->distance( ... )

In list context, return a detailed report mapping each search key to a distance value. In scalar context, return an overall summary distance, such that sorting entries by the return values of this method in ascending order will place the closest matches at the top of the list.

A valid distance is non-negative. Negative distance values indicate that the record does not match the criteria at all. An undefined value indicates that the entry is from an index that does not store the information needed to evaluate distance for that search key. Undefined values are ignored when computing the summarized distance, but the summarized distance will be negative if any keys do not match at all.

For details on available search keys, see the "Search Keys" section of the WARC::Collection page.

AUTHOR

Jacob Bachmeyer, <jcb@cpan.org>

SEE ALSO

WARC, WARC::Index

COPYRIGHT AND LICENSE

Copyright (C) 2019 by Jacob Bachmeyer

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.