README.md 2.1 KB
Newer Older
M
Marius Muja 已提交
1
FLANN - Fast Library for Approximate Nearest Neighbors
M
Marius Muja 已提交
2 3
======================================================

M
Marius Muja 已提交
4 5 6 7 8 9 10
FLANN is a library for performing fast approximate nearest neighbor searches in high dimensional spaces. It contains a collection of algorithms we found to work best for nearest neighbor search and a system for automatically choosing the best algorithm and optimum parameters depending on the dataset.
FLANN is written in C++ and contains bindings for the following languages: C, MATLAB and Python.


Documentation
-------------

M
Marius Muja 已提交
11 12
Check FLANN web page [here](http://www.cs.ubc.ca/~mariusm/flann).

M
Marius Muja 已提交
13
Documentation on how to use the library can be found in the doc/manual.pdf file included in the release archives.
M
Marius Muja 已提交
14

M
Marius Muja 已提交
15
More information and experimental results can be found in the following paper:
M
Marius Muja 已提交
16

M
Marius Muja 已提交
17
  * Marius Muja and David G. Lowe, "Fast Approximate Nearest Neighbors with Automatic Algorithm Configuration", in International Conference on Computer Vision Theory and Applications (VISAPP'09), 2009 [(PDF)](http://people.cs.ubc.ca/~mariusm/uploads/FLANN/flann_visapp09.pdf) [(BibTex)](http://people.cs.ubc.ca/~mariusm/index.php/FLANN/BibTex)
M
Marius Muja 已提交
18 19


M
Marius Muja 已提交
20 21 22 23 24
Getting FLANN
-------------

The latest version of FLANN can be downloaded from here:

M
Marius Muja 已提交
25 26 27
 *  Version 1.6.10 (16 May 2010)
    [flann-1.6.10-src.zip](http://people.cs.ubc.ca/~mariusm/uploads/FLANN/flann-1.6.10-src.zip) (Source code)  
    [User manual](http://people.cs.ubc.ca/~mariusm/uploads/FLANN/flann_manual-1.6.10.pdf)  
M
Marius Muja 已提交
28 29 30 31 32 33 34 35 36 37 38 39 40
    [Changelog](https://github.com/mariusmuja/flann/blob/master/ChangeLog)  

If you want to try out the latest changes or contribute to FLANN, then it's recommended that you checkout the git source repository: `git clone git://github.com/mariusmuja/flann.git`

If you just want to browse the repository, you can do so by going [here](https://github.com/mariusmuja/flann).

Conditions of use
-----------------

FLANN is distributed under the terms of the [BSD License](https://github.com/mariusmuja/flann/blob/master/COPYING).

Bug reporting
-------------
M
Marius Muja 已提交
41

M
Marius Muja 已提交
42
Please report bugs or feature requests using [github's issue tracker](http://github.com/mariusmuja/flann/issues).