Merge

Author: Marius Muja

.gitignore

@@ -15,7 +15,6 @@ test/flann_simple_test
 test/flann_uint_autotune.py
 build
 build_win
-lib
 dist/
 flann.kdev4
 TODO

README.md

@@ -2,7 +2,7 @@ FLANN - Fast Library for Approximate Nearest Neighbors
 ======================================================
 
 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.
+FLANN is written in C++ and contains bindings for the following languages: C, MATLAB, Python, and Ruby.
 
 
 Documentation

doc/manual.pdf

@@ -50,7 +50,7 @@ \section{Introduction}
 FLANN (Fast Library for Approximate Nearest Neighbors) is a library for
 performing fast approximate nearest neighbor searches. FLANN is written in
 the C++ programming language. FLANN can be easily used in many contexts
-through the C, MATLAB and Python bindings provided with the library.
+through the C, MATLAB, Python, and Ruby bindings provided with the library.
 
 
 
@@ -59,7 +59,7 @@ \subsection{Quick Start}
 
 
 This section contains small examples of how to use the FLANN library from
-different programming languages (C++, C, MATLAB and Python).
+different programming languages (C++, C, MATLAB, Python, and Ruby).
 
 \begin{itemize}
 
@@ -187,6 +187,31 @@ \subsection{Quick Start}
                branching=32, iterations=7, checks=16);
 \end{Verbatim}
 
+\item \textbf{Ruby}
+\begin{Verbatim}[fontsize=\scriptsize,frame=single]
+require 'flann' # also requires NMatrix
+
+dataset = NMatrix.random([10000,128])
+testset = NMatrix.random([1000,128])
+
+index   = Flann::Index.new(dataset) do |params|
+  params[:algorithm]  = :kmeans
+  params[:branching]  = 32
+  params[:iterations] = 7
+  params[:checks]     = 16
+end
+speedup = index.build! # this is optional
+
+results, distances = index.nearest_neighbors(testset, 5)
+
+index.save "my_index.save"
+
+# Alternatively, without an index:
+results, distances = Flann.nearest_neighbors(dataset, testset, 5,
+                      algorithm: :kmeans, branching: 32,
+                      iterations: 7, checks: 16)
+
+\end{Verbatim}
 \end{itemize}
 
 
@@ -1539,7 +1564,7 @@ \subsection{Using FLANN from python}
 
 
 
-See section \ref{sec:quickstart} for an example of how to use the Python
+See section \ref{sec:quickstart} for an example of how to use the Python and Ruby
 bindings.
 
 

doc/manual.tex

@@ -191,6 +191,15 @@ void flann_set_distance_type(flann_distance_t distance_type, int order)
 }
 
 
+flann_distance_t flann_get_distance_type() {
+  return flann_distance_type;
+}
+
+int flann_get_distance_order() {
+  return flann_distance_order;
+}
+
+
 template<typename Distance>
 flann_index_t __flann_build_index(typename Distance::ElementType* dataset, int rows, int cols, float* speedup,
                                   FLANNParameters* flann_params, Distance d = Distance())

src/cpp/flann/flann.cpp

@@ -100,6 +100,16 @@ FLANN_EXPORT void flann_log_verbosity(int level);
  */
 FLANN_EXPORT void flann_set_distance_type(enum flann_distance_t distance_type, int order);
 
+/**
+ * Gets the distance type in use throughout FLANN.
+ */
+FLANN_EXPORT enum flann_distance_t flann_get_distance_type();
+
+/**
+ * Gets the distance order in use throughout FLANN (only applicable if minkowski distance
+ * is in use).
+ */
+FLANN_EXPORT int flann_get_distance_order();
 
 /**
    Builds and returns an index. It uses autotuning if the target_precision field of index_params

src/cpp/flann/flann.h

@@ -0,0 +1,36 @@
+# Copyright 2014 John O. Woods ([email protected]), West Virginia
+#   University's Applied Space Exploration Lab, and West Virginia Robotic
+#   Technology Center. All rights reserved.
+#
+# THE BSD LICENSE
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+source 'https://rubygems.org'
+gemspec
+
+gem "ffi"
+gem "nmatrix"
+
+group :development do
+
+end

src/ruby/Gemfile

@@ -0,0 +1,10 @@
+Copyright (c) 2014, John Woods, WVU Applied Space Exploration Laboratory, and West Virginia Robotic Technology Center.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

src/ruby/LICENSE.txt

@@ -0,0 +1,12 @@
+Rakefile
+Gemfile
+LICENSE.txt
+Manifest.txt
+flann.gemspec
+lib/flann.rb
+lib/index.rb
+lib/flann/index.rb
+lib/flann/version.rb
+spec/spec_helper.rb
+spec/flann_spec.rb
+spec/index_spec.rb

src/ruby/Manifest.txt

@@ -0,0 +1,111 @@
+# Copyright 2014 John O. Woods ([email protected]), West Virginia
+#   University's Applied Space Exploration Lab, and West Virginia Robotic
+#   Technology Center. All rights reserved.
+#
+# THE BSD LICENSE
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'rubygems'
+require 'rubygems/package_task'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+gemspec = eval(IO.read("flann.gemspec"))
+
+Gem::PackageTask.new(gemspec).define
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{gem install pkg/flann-#{NMatrix::VERSION}.gem}
+end
+
+
+require 'rspec/core/rake_task'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb'].uniq
+end
+
+task :console do |task|
+  cmd = [ 'irb', "-r './lib/flann.rb'" ]
+  run *cmd
+end
+
+task :pry do |task|
+  cmd = [ 'pry', "-r './lib/flann.rb'" ]
+  run *cmd
+end
+
+
+task :default => :spec
+
+def run *cmd
+  sh(cmd.join(" "))
+end
+
+
+desc "Check the manifest for correctness"
+task :check_manifest do |task|
+  manifest_files  = File.read("Manifest.txt").split
+
+  git_files       = `git ls-files |grep -v 'spec/'`.split
+  ignore_files    = %w{.gitignore .rspec}
+
+  possible_files  = git_files - ignore_files
+
+  missing_files   = possible_files - manifest_files
+  extra_files     = manifest_files - possible_files
+
+  unless missing_files.empty?
+    STDERR.puts "The following files are in the git repo but not the Manifest:"
+    missing_files.each { |f| STDERR.puts " -- #{f}"}
+  end
+
+  unless extra_files.empty?
+    STDERR.puts "The following files are in the Manifest but may not be necessary:"
+    extra_files.each { |f| STDERR.puts " -- #{f}"}
+  end
+
+  if extra_files.empty? && missing_files.empty?
+    STDERR.puts "Manifest looks good!"
+  end
+
+end
+
+
+require "rdoc/task"
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include(%w{README.rdoc History.txt LICENSE.txt lib/flann/**/*.rb})
+end
+
+# vim: syntax=ruby