https://github.com/wildart/flann.jl

A Julia wrapper for Fast Library for Approximate Nearest Neighbors (FLANN)
https://github.com/wildart/flann.jl

approximate-nearest-neighbors flann julia nearest-neighbors

Last synced: 20 days ago
JSON representation

A Julia wrapper for Fast Library for Approximate Nearest Neighbors (FLANN)

• Host: GitHub
• URL: https://github.com/wildart/flann.jl
• Owner: wildart
• License: other
• Created: 2014-06-07T00:27:35.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-04-08T16:22:42.000Z (8 months ago)
• Last Synced: 2024-10-10T11:06:29.798Z (about 1 month ago)
• Topics: approximate-nearest-neighbors, flann, julia, nearest-neighbors
• Language: Julia
• Homepage:
• Size: 64.5 KB
• Stars: 16
• Watchers: 2
• Forks: 14
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
FLANN.jl [![][CI-img]][CI-url] [![][coverage-img]][coverage-url]

========

A simple wrapper for [FLANN](https://github.com/flann-lib/flann), Fast Library for Approximate Nearest Neighbors. It has an interface similar to the [NearestNeighbors](https://github.com/KristofferC/NearestNeighbors.jl) package API.

# Installation

Prerequisites for building binary dependency: `gcc`, `cmake`, `liblz4`.

Use the package manager to install:

	pkg> add FLANN

# Usage Example

```julia

using Distances

using FLANN

X = readdlm(Pkg.dir("FLANN", "test", "iris.csv"), ',')

v = X[:, 84]

k = 3

r = 10.0

idxs, dsts = knn(X, v, k, FLANNParameters())

# or

t = flann(X, FLANNParameters(), Minkowski(3))

inds, dists = knn(t, v, k)

# or

idxs, dsts = inrange(t, v, r)

# Do not forget to close index!

close(t)

```

# TODO

* Documentation

[CI-img]: https://github.com/wildart/FLANN.jl/actions/workflows/CI.yml/badge.svg

[CI-url]: https://github.com/wildart/FLANN.jl/actions/workflows/CI.yml

[coverage-img]: https://coveralls.io/repos/wildart/FLANN.jl/badge.svg?branch=master

[coverage-url]: https://coveralls.io/r/wildart/FLANN.jl?branch=master