Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Search::InvertedIndex:UseraContributed Perl DoSearch::InvertedIndex::Update(3)

NAME
       Search::InvertedIndex::Update - A container for a mass data update for
       a -group/-index.

SYNOPSIS
DESCRIPTION
       Provides	a container for	the information	to perform an update for a
       -group/-index tuple.

   Public API
       Inherits	'get','set','clear' and	'exists' methods from
       Class::NamedParms

   Initialization
       "new({ -group =>	$group,	-index => $index, -keys	=> { ... ) [ -data ="
       > $data ] });>
	   Returns and optionally initializes a	new
	   Search::InvertedIndex::Update object.

	   Examples:

	     my	$update	= Search::InvertedIndex::Update->new;

	     my	$update	= Search::InvertedIndex::Update->new({ -group => $group,
							       -index => $index,
								-data => $index_data,
								-keys => {
															  $key0	=> 10,
																      $key1 => 20,
																      $key2 => 15,
															    },
													    });

	   Inherits 'get/set' methods from Class::NamedParms

	   The -keys parameter is a reference to a hash	containing all the
	   keys	for this index and their assigned rankings. Rankings are
	   allowed to be integer values	between	-32768 and +32767 inclusive.

	   The -group and -index are required, the -keys are optional. The
	   Update object is used for update by replacement of all -keys	for
	   the specified -group	and -index.  All existing keys are deleted and
	   the passed -keys is used to insert a	completely new set of keys for
	   the specified index/group.

	   The -data parameter is optional, but	if passed will replace the
	   existing -data record for the -index.

COPYRIGHT
       Copyright 1999-2020, Jerilyn Franz and FreeRun Technologies, Inc.
       (<URL:http://www.freeruntech.com/>).  All Rights	Reserved.

AUTHOR
       Jerilyn Franz

TODO
       Everything.

perl v5.32.1			  2020-09-27  Search::InvertedIndex::Update(3)

NAME | SYNOPSIS | DESCRIPTION | COPYRIGHT | AUTHOR | TODO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Search::InvertedIndex::Update&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help