WordList::Mod::Bloom - Provide word_exists() that uses bloom filter
This document describes version 0.001 of WordList::Mod::Bloom (from Perl distribution WordList-Mod-Bloom), released on 2018-04-02.
In your WordList/EN/Foo.pm:
package WordList::EN::Foo; __DATA__ word1 word2 ...
In your WordList/Bloom/EN/Foo.pm:
package WordList::Bloom::EN::Foo; 1; __DATA__ (The actual bloom filter, base64-encoded)
Then:
use WordList::Mod qw(get_mod_wordlist); my $wl = get_mod_wordlist("EN::Foo", "Bloom"); $wl->word_exists("foo"); # uses bloom filter to check for existence.
EXPERIMENTAL.
This mod provides an alternative word_exists() method that checks a bloom filter located in the data section of WordList::Bloom::<Your_WordList_Subpackage>. 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.
word_exists()
WordList::Bloom::<Your_WordList_Subpackage>
Please visit the project's homepage at https://metacpan.org/release/WordList-Mod-Bloom.
Source repository is at https://github.com/perlancar/perl-WordList-Mod-Bloom.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=WordList-Mod-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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2018 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.
To install WordList::Mod::Bloom, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WordList::Mod::Bloom
CPAN shell
perl -MCPAN -e shell install WordList::Mod::Bloom
For more information on module installation, please visit the detailed CPAN module installation guide.