NAME

WordListRole::Bloom - Provide word_exists() that uses bloom filter

VERSION

This document describes version 0.006 of WordListRole::Bloom (from Perl distribution WordListRole-Bloom), released on 2020-05-24.

SYNOPSIS

In your lib/WordList/EN/Foo.pm:

 package WordList::EN::Foo;

 use parent 'WordList';

 use Role::Tiny::With;
 with 'WordListRole::Bloom';

 __DATA__
 word1
 word2
 ...

In your share/bloom, create your bloom filter data file, e.g. with bloomgen:

 % perl -ne 'print if (/^__DATA__$/ .. 0) && $i++' lib/WordList/EN/Foo.pm | \
   bloomgen -n 1234 -p 0.1% > share/bloom

(where -n is set to the number of words, -p to the maximum false-positive rate).

After that, in yourscript.pl:

 my $wl = WordList::EN::Foo->new;
 $wl->word_exists("foo"); # uses bloom filter to check for existence.

DESCRIPTION

This role provides an alternative word_exists() method that checks a bloom filter located in the distribution share directory (share/bloom). This provides a low startup-overhead way to check an item against a big list (e.g. millions). Note that testing using a bloom filter can result in a false positive (i.e. word_exists() returns true but the word is not actually in the list.

PROVIDED METHODS

word_exists

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/WordListRole-Bloom.

SOURCE

Source repository is at https://github.com/perlancar/perl-WordListRole-Bloom.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=WordListRole-Bloom

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020 by perlancar@cpan.org.

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