https://github.com/creadone/xor
Xor-filter
https://github.com/creadone/xor
Last synced: about 1 month ago
JSON representation
Xor-filter
- Host: GitHub
- URL: https://github.com/creadone/xor
- Owner: creadone
- License: mit
- Created: 2023-03-29T18:34:03.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-29T18:37:14.000Z (about 3 years ago)
- Last Synced: 2025-02-02T20:35:37.103Z (over 1 year ago)
- Language: Ruby
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Xor::Filter
Naive implementation of Xor-filter for algorithm testing purposes.
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add xor
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install xor
## Usage
```ruby
require 'xor'
filter = Xor::Filter.new(100)
filter.add('bar')
puts filter.include?('bar') # true
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/creadone/xor.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).