WordListRole::Bloom - Provide word_exists() that uses bloom filter
This document describes version 0.007 of WordListRole::Bloom (from Perl distribution WordListRole-Bloom), released on 2022-08-20.
In your lib/WordList/EN/Foo.pm:
use parent 'WordList';
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.
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.
Please visit the project's homepage at https://metacpan.org/release/WordListRole-Bloom.
Source repository is at https://github.com/perlancar/perl-WordListRole-Bloom.
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2020 by perlancar <firstname.lastname@example.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.
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.
To install WordListRole::Bloom, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.