https://github.com/generall/vptree
VP-tree implementation in ruby
https://github.com/generall/vptree
Last synced: about 1 year ago
JSON representation
VP-tree implementation in ruby
- Host: GitHub
- URL: https://github.com/generall/vptree
- Owner: generall
- License: mit
- Created: 2015-12-26T17:29:11.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-02-11T19:18:05.000Z (over 10 years ago)
- Last Synced: 2025-06-10T07:56:10.272Z (about 1 year ago)
- Language: Ruby
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Vptree
[](https://travis-ci.org/generall/vptree)
Implementation of VP-tree (https://en.wikipedia.org/wiki/Vantage-point_tree) for fast kNN search with any measure function.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'vptree'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install vptree
## Usage
Building tree:
```ruby
data = [[1,2], [2,1] , [2,2]]
# any measure, satisfies the triangle inequality, is allowed
# and may be passed as block
tree = Vptree::VPTree.new(data) # data - array of vectors of objects with special mixin, see https://github.com/generall/Distance-Measures
```
Quering tree:
```ruby
nearest = tree.find_k_nearest([3,3], 1)
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, 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/generall/vptree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).