annoy-rb 0.2.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a7ab55f832f0ce57d4e8c010e69fdcee979764cea2579d5833ae1d3b0c24af9
-  data.tar.gz: 245451b8edd07984b8bcfd515bb1caa75a4164309954d9278aabce76ad9646c2
+  metadata.gz: 1ae4f03fb87f0ea9ab0ff8ff13eb5c011cfd51931e5b4fc63c9a480560e9b102
+  data.tar.gz: 815d1f92d975ad932cc608a50a0bf983477d4fb3554aec5cd2978d904fe766b1
 SHA512:
-  metadata.gz: b4c357d55bba00461433a2d63350216eaecb45ab421b2acc5a51a7276eb6922ef58ae1ad6775bd847d56805207e24e23c93944b3e434acdd059bc67d2177e2db
-  data.tar.gz: 4619de7cbde449ba58495ac1a98090cc0c8a6737d31769cb37134f1e351ddc1ad0ade9b4806a9e8d965a1e9272e9df11962f77d5380d6ad0f1819a6ef0dd2164
+  metadata.gz: 2dd6f50030ac181a66633ea63c1e616ddb3b931227ce002d25b8ec5fb5b7d9094e6e0970bb9367bfe63004bce448bdb318658d17bc089d7af2978cdfdc33c776
+  data.tar.gz: f6c5995f2a7986e2c6dfba83bccf3a41b52e564dfce503c4def30395c3c19287422a93d1e62fd5a139e824bf2372910c415cb6cc66c22c41833153790f3bbc1f

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+## 0.6.0
+- Add `dtype` argument to initialize method to specify the data type of vector element.
+If you want to load a search index created with the Python bindings, specify 'float32' to the dtype argument.
+
+```
+require 'annoy'
+
+f = 40
+t = Annoy::AnnoyIndex.new(n_features: f, metric: 'angular', dtype: 'float32')
+t.load('index_with_python_bindings.ann')
+```
+
+- Change the data type of item index from int to int32_t.
+- Update type declarations and documentations.
+- Introduce conventional commits.
+
+## 0.5.0
+### Breaking change
+- Remove `-march=native` and `-DANNOYLIB_MULTITHREADED_BUILD` from CXXFLAGS.
+For example, the installation command to reproduce the same build as the previous version is as follows:
+
+```
+$ gem install annoy-rb -- --with-cxxflags=-march=native -DANNOYLIB_MULTITHREADED_BUILD
+```
+
+```
+$ bundle config --local build.annoy-rb "--with-cxxflags=-march=native -DANNOYLIB_MULTITHREADED_BUILD"
+$ bundle install
+```
+
+## 0.4.0
+- Add dummy constructor call at memory allocation of binding class to prevent occuring segment fault on GC when initialize method is failed.
+
+## 0.3.0
+- Add type declaration file: sig/annoy.rbs
+- Fix get_distance method to return integer typed value on hamming metric index.
+- Rename native extension files.
+
 ## 0.2.3
 - Add GC guard to index saving and loading methods.
 

data/README.md

@@ -5,7 +5,7 @@
 [![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://github.com/yoshoku/annoy.rb/blob/main/LICENSE.txt)
 [![Documentation](http://img.shields.io/badge/api-reference-blue.svg)](https://yoshoku.github.io/annoy.rb/doc/)
 
-Annoy.rb is a Ruby binding for the [Annoy (Approximate Nearest Neighbors Oh Yeah)](https://github.com/spotify/annoy).
+Annoy.rb provides Ruby bindings for the [Annoy (Approximate Nearest Neighbors Oh Yeah)](https://github.com/spotify/annoy).
 
 ## Installation
 
@@ -50,14 +50,24 @@ u.load('test.ann')
 p u.get_nns_by_item(0, 100) # will find the 100 nearest neighbors.
 ```
 
+With the default argument, annoy.rb uses double precision floating point type for the data type of vector element.
+On the other hand, the [Python bindings of Annoy](https://pypi.org/project/annoy/) use single precision floating point type.
+If you want to load a search index created with the Python bindings, specify 'float32' to the dtype argument.
+
+```ruby
+require 'annoy'
+
+f = 40
+t = Annoy::AnnoyIndex.new(n_features: f, metric: 'angular', dtype: 'float32')
+t.load('index_with_python_bindings.ann')
+```
+
 ## License
 
 The gem is available as open source under the terms of the [Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/annoy.rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/yoshoku/annoy.rb/blob/main/CODE_OF_CONDUCT.md).
-
-## Code of Conduct
-
-Everyone interacting in the Annoy.rb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/annoy.rb/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/annoy.rb.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/ext/annoy/annoyext.cpp

@@ -0,0 +1,35 @@
+/**
+ * Annoy.rb is a Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).
+ *
+ * Copyright (c) 2020-2022 Atsushi Tatsuma
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "annoyext.hpp"
+
+extern "C"
+void Init_annoyext(void)
+{
+  VALUE rb_mAnnoy = rb_define_module("Annoy");
+  RbAnnoyIndex<AnnoyIndexAngular<double>, double>::define_class(rb_mAnnoy, "AnnoyIndexAngular");
+  RbAnnoyIndex<AnnoyIndexDotProduct<double>, double>::define_class(rb_mAnnoy, "AnnoyIndexDotProduct");
+  RbAnnoyIndex<AnnoyIndexHamming<uint64_t>, uint64_t>::define_class(rb_mAnnoy, "AnnoyIndexHamming");
+  RbAnnoyIndex<AnnoyIndexEuclidean<double>, double>::define_class(rb_mAnnoy, "AnnoyIndexEuclidean");
+  RbAnnoyIndex<AnnoyIndexManhattan<double>, double>::define_class(rb_mAnnoy, "AnnoyIndexManhattan");
+
+  RbAnnoyIndex<AnnoyIndexAngular<float>, float>::define_class(rb_mAnnoy, "AnnoyIndexAngularFloat32");
+  RbAnnoyIndex<AnnoyIndexDotProduct<float>, float>::define_class(rb_mAnnoy, "AnnoyIndexDotProductFloat32");
+  RbAnnoyIndex<AnnoyIndexEuclidean<float>, float>::define_class(rb_mAnnoy, "AnnoyIndexEuclideanFloat32");
+  RbAnnoyIndex<AnnoyIndexManhattan<float>, float>::define_class(rb_mAnnoy, "AnnoyIndexManhattanFloat32");
+}

data/ext/annoy/{annoy.hpp → annoyext.hpp}

@@ -1,7 +1,7 @@
 /**
  * Annoy.rb is a Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).
  *
- * Copyright (c) 2020 Atsushi Tatsuma
+ * Copyright (c) 2020-2022 Atsushi Tatsuma
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,8 +16,8 @@
  * limitations under the License.
  */
 
-#ifndef ANNOY_HPP
-#define ANNOY_HPP 1
+#ifndef ANNOYEXT_HPP
+#define ANNOYEXT_HPP 1
 
 #include <typeinfo>
 
@@ -31,17 +31,18 @@
   typedef AnnoyIndexSingleThreadedBuildPolicy AnnoyIndexThreadedBuildPolicy;
 #endif
 
-typedef AnnoyIndex<int, double, Angular, Kiss64Random, AnnoyIndexThreadedBuildPolicy> AnnoyIndexAngular;
-typedef AnnoyIndex<int, double, DotProduct, Kiss64Random, AnnoyIndexThreadedBuildPolicy> AnnoyIndexDotProduct;
-typedef AnnoyIndex<int, uint64_t, Hamming, Kiss64Random, AnnoyIndexThreadedBuildPolicy> AnnoyIndexHamming;
-typedef AnnoyIndex<int, double, Euclidean, Kiss64Random, AnnoyIndexThreadedBuildPolicy> AnnoyIndexEuclidean;
-typedef AnnoyIndex<int, double, Manhattan, Kiss64Random, AnnoyIndexThreadedBuildPolicy> AnnoyIndexManhattan;
+template<typename F> using AnnoyIndexAngular = AnnoyIndex<int32_t, F, Angular, Kiss64Random, AnnoyIndexThreadedBuildPolicy>;
+template<typename F> using AnnoyIndexDotProduct = AnnoyIndex<int32_t, F, DotProduct, Kiss64Random, AnnoyIndexThreadedBuildPolicy>;
+template<typename F> using AnnoyIndexHamming = AnnoyIndex<int32_t, F, Hamming, Kiss64Random, AnnoyIndexThreadedBuildPolicy>;
+template<typename F> using AnnoyIndexEuclidean = AnnoyIndex<int32_t, F, Euclidean, Kiss64Random, AnnoyIndexThreadedBuildPolicy>;
+template<typename F> using AnnoyIndexManhattan = AnnoyIndex<int32_t, F, Manhattan, Kiss64Random, AnnoyIndexThreadedBuildPolicy>;
 
 template<class T, typename F> class RbAnnoyIndex
 {
   public:
     static VALUE annoy_index_alloc(VALUE self) {
       T* ptr = (T*)ruby_xmalloc(sizeof(T));
+      new (ptr) T();
       return TypedData_Wrap_Struct(self, &annoy_index_type, ptr);
     };
 
@@ -93,7 +94,7 @@ template<class T, typename F> class RbAnnoyIndex
     };
 
     static VALUE _annoy_index_add_item(VALUE self, VALUE _idx, VALUE arr) {
-      const int idx = NUM2INT(_idx);
+      const int32_t idx = (int32_t)NUM2INT(_idx);
       const int n_dims = get_annoy_index(self)->get_f();
 
       if (!RB_TYPE_P(arr, T_ARRAY)) {
@@ -171,11 +172,11 @@ template<class T, typename F> class RbAnnoyIndex
     };
 
     static VALUE _annoy_index_get_nns_by_item(VALUE self, VALUE _idx, VALUE _n_neighbors, VALUE _search_k, VALUE _include_distances) {
-      const int idx = NUM2INT(_idx);
+      const int32_t idx = (int32_t)NUM2INT(_idx);
       const int n_neighbors = NUM2INT(_n_neighbors);
       const int search_k = NUM2INT(_search_k);
       const bool include_distances = _include_distances == Qtrue ? true : false;
-      std::vector<int> neighbors;
+      std::vector<int32_t> neighbors;
       std::vector<F> distances;
 
       get_annoy_index(self)->get_nns_by_item(idx, n_neighbors, search_k, &neighbors, include_distances ? &distances : NULL);
@@ -184,7 +185,7 @@ template<class T, typename F> class RbAnnoyIndex
       VALUE neighbors_arr = rb_ary_new2(sz_neighbors);
 
       for (int i = 0; i < sz_neighbors; i++) {
-        rb_ary_store(neighbors_arr, i, INT2NUM(neighbors[i]));
+        rb_ary_store(neighbors_arr, i, INT2NUM((int)(neighbors[i])));
       }
 
       if (include_distances) {
@@ -223,7 +224,7 @@ template<class T, typename F> class RbAnnoyIndex
       const int n_neighbors = NUM2INT(_n_neighbors);
       const int search_k = NUM2INT(_search_k);
       const bool include_distances = _include_distances == Qtrue ? true : false;
-      std::vector<int> neighbors;
+      std::vector<int32_t> neighbors;
       std::vector<F> distances;
 
       get_annoy_index(self)->get_nns_by_vector(vec, n_neighbors, search_k, &neighbors, include_distances ? &distances : NULL);
@@ -234,7 +235,7 @@ template<class T, typename F> class RbAnnoyIndex
       VALUE neighbors_arr = rb_ary_new2(sz_neighbors);
 
       for (int i = 0; i < sz_neighbors; i++) {
-        rb_ary_store(neighbors_arr, i, INT2NUM(neighbors[i]));
+        rb_ary_store(neighbors_arr, i, INT2NUM((int)(neighbors[i])));
       }
 
       if (include_distances) {
@@ -253,7 +254,7 @@ template<class T, typename F> class RbAnnoyIndex
     };
 
     static VALUE _annoy_index_get_item(VALUE self, VALUE _idx) {
-      const int idx = NUM2INT(_idx);
+      const int32_t idx = (int32_t)NUM2INT(_idx);
       const int n_dims = get_annoy_index(self)->get_f();
       F* vec = (F*)ruby_xmalloc(n_dims * sizeof(F));
       VALUE arr = rb_ary_new2(n_dims);
@@ -269,10 +270,10 @@ template<class T, typename F> class RbAnnoyIndex
     };
 
     static VALUE _annoy_index_get_distance(VALUE self, VALUE _i, VALUE _j) {
-      const int i = NUM2INT(_i);
-      const int j = NUM2INT(_j);
-      const double dist = get_annoy_index(self)->get_distance(i, j);
-      return DBL2NUM(dist);
+      const int32_t i = (int32_t)NUM2INT(_i);
+      const int32_t j = (int32_t)NUM2INT(_j);
+      const F dist = get_annoy_index(self)->get_distance(i, j);
+      return typeid(F) == typeid(double) ? DBL2NUM(dist) : UINT2NUM(dist);
     };
 
     static VALUE _annoy_index_get_n_items(VALUE self) {
@@ -329,4 +330,4 @@ const rb_data_type_t RbAnnoyIndex<T, F>::annoy_index_type = {
   RUBY_TYPED_FREE_IMMEDIATELY
 };
 
-#endif /* ANNOY_HPP */
+#endif /* ANNOYEXT_HPP */

data/ext/annoy/extconf.rb

@@ -2,8 +2,8 @@ require 'mkmf'
 
 abort 'libstdc++ is not found.' unless have_library('stdc++')
 
-$CXXFLAGS << " -std=c++14 -march=native -DANNOYLIB_MULTITHREADED_BUILD"
+$CXXFLAGS << " -std=c++14"
 $INCFLAGS << " -I$(srcdir)/src"
 $VPATH << "$(srcdir)/src"
 
-create_makefile('annoy/annoy')
+create_makefile('annoy/annoyext')

data/ext/annoy/src/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/ext/annoy/src/annoylib.h

@@ -868,6 +868,8 @@ protected:
   bool _built;
 public:
 
+   AnnoyIndex() : _f(0), _fd(0), _nodes(NULL), _n_items(0), _n_nodes(0), _nodes_size(0),
+                  _is_seeded(false), _loaded(false), _verbose(false), _on_disk(false), _built(false)  { }
    AnnoyIndex(int f) : _f(f) {
     _s = offsetof(Node, v) + _f * sizeof(T); // Size of each node
     _verbose = false;

data/lib/annoy/version.rb

@@ -3,5 +3,8 @@
 # Annoy.rb is a Ruby wrapper for Annoy (Approximate Nearest Neighbors Oh Yeah).
 module Annoy
   # The version of Annoy.rb you are using.
-  VERSION = '0.2.3'.freeze
+  VERSION = '0.6.0'
+
+  # The version of Annoy included with gem.
+  ANNOY_VERSION = '1.17.0'
 end

data/lib/annoy.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'annoy/version'
-require 'annoy/annoy'
+require 'annoy/annoyext'
 
 module Annoy
   # AnnoyIndex is a class that provides functions for k-nearest neighbors search.
@@ -30,27 +30,35 @@ module Annoy
     # @return [String]
     attr_reader :metric
 
+    # Returns the data type of feature.
+    # @return [String]
+    attr_reader :dtype
+
     # Create a new search index.
     #
     # @param n_features [Integer] The number of features (dimensions) of stored vector.
     # @param metric [String] The distance metric between vectors ('angular', 'dot', 'hamming', 'euclidean', or 'manhattan').
-    def initialize(n_features:, metric: 'angular')
+    # @param dtype [String] The data type of features ('float64' and 'float32').
+    #   If metric is given 'hamming', 'uint64' is automatically assigned to this argument.
+    def initialize(n_features:, metric: 'angular', dtype: 'float64')
       raise ArgumentError, 'Expect n_features to be Integer.' unless n_features.is_a?(Numeric)
 
       @n_features = n_features.to_i
       @metric = metric
+      @dtype = dtype
 
       @index = case @metric
                when 'angular'
-                 AnnoyIndexAngular.new(@n_features)
+                 @dtype == 'float64' ? AnnoyIndexAngular.new(@n_features) : AnnoyIndexAngularFloat32.new(@n_features)
                when 'dot'
-                 AnnoyIndexDotProduct.new(@n_features)
+                 @dtype == 'float64' ? AnnoyIndexDotProduct.new(@n_features) : AnnoyIndexDotProductFloat32.new(@n_features)
                when 'hamming'
+                 @dtype = 'uint64'
                  AnnoyIndexHamming.new(@n_features)
                when 'euclidean'
-                 AnnoyIndexEuclidean.new(@n_features)
+                 @dtype == 'float64' ? AnnoyIndexEuclidean.new(@n_features) : AnnoyIndexEuclideanFloat32.new(@n_features)
                when 'manhattan'
-                 AnnoyIndexManhattan.new(@n_features)
+                 @dtype == 'float64' ? AnnoyIndexManhattan.new(@n_features) : AnnoyIndexManhattanFloat32.new(@n_features)
                else
                  raise ArgumentError, "No such metric: #{@metric}."
                end
@@ -69,6 +77,7 @@ module Annoy
     #
     # @param n_trees [Integer] The number of trees. More trees gives higher search precision.
     # @param n_jobs [Integer] The number of threads used to build the trees. If -1 is given, uses all available CPU cores.
+    # This parameter is enabled only if "-DANNOYLIB_MULTITHREADED_BUILD" is specified on gem installation.
     # @return [Boolean]
     def build(n_trees, n_jobs: -1)
       @index.build(n_trees, n_jobs)

data/sig/annoy.rbs

@@ -0,0 +1,188 @@
+module Annoy
+  VERSION: String
+  ANNOY_VERSION: String
+
+  class AnnoyIndex
+    attr_reader n_features: Integer
+    attr_reader metric: String
+    attr_reader dtype: String
+
+    def initialize: (n_features: Integer n_features, ?metric: String metric, ?dtype: String dtype) -> void
+    def add_item: (Integer i, Array[Float | Integer] v) -> bool
+    def build: (Integer n_trees, ?n_jobs: Integer n_jobs) -> bool
+    def save: (String filename, ?prefault: bool prefault) -> bool
+    def load: (String filename, ?prefault: bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, ?search_k: Integer search_k, ?include_distances: (true | false) include_distances) -> ([Array[Integer], Array[Float | Integer]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float | Integer] v, Integer n, ?search_k: Integer search_k, ?include_distances: (true | false) include_distances) -> ([Array[Integer], Array[Float | Integer]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float | Integer]
+    def get_distance: (Integer i, Integer j) -> (Float | Integer)
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexAngular
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexAngularFloat32
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexDotProduct
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexDotProductFloat32
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexHamming
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Integer] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Integer]] | Array[Integer])
+    def get_nns_by_vector: (Array[Integer] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Integer]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Integer]
+    def get_distance: (Integer i, Integer j) -> Integer
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexEuclidean
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexEuclideanFloat32
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexManhattan
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexManhattanFloat32
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: annoy-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.6.0
 platform: ruby
 authors:
 - yoshoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2022-01-23 00:00:00.000000000 Z
 dependencies: []
-description: Annoy.rb is a Ruby binding for the Annoy (Approximate Nearest Neighbors
+description: Annoy.rb provides Ruby bindings for the Annoy (Approximate Nearest Neighbors
   Oh Yeah).
 email:
 - yoshoku@outlook.com
@@ -19,24 +19,19 @@ extensions:
 - ext/annoy/extconf.rb
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- annoy-rb.gemspec
-- ext/annoy/annoy.cpp
-- ext/annoy/annoy.hpp
+- ext/annoy/annoyext.cpp
+- ext/annoy/annoyext.hpp
 - ext/annoy/extconf.rb
+- ext/annoy/src/LICENSE
 - ext/annoy/src/annoylib.h
 - ext/annoy/src/kissrandom.h
 - ext/annoy/src/mman.h
 - lib/annoy.rb
 - lib/annoy/version.rb
+- sig/annoy.rbs
 homepage: https://github.com/yoshoku/annoy.rb
 licenses:
 - Apache-2.0
@@ -60,8 +55,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).
+summary: Ruby bindings for the Annoy (Approximate Nearest Neighbors Oh Yeah).
 test_files: []

data/.github/workflows/build.yml

@@ -1,21 +0,0 @@
-name: build
-
-on: [push, pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby: [ '2.5', '2.6', '2.7' ]
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set upt Ruby ${{ matrix.ruby }}
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Build and test with Rake
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-          bundle exec rake

data/.gitignore

@@ -1,21 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-
-# rspec failure tracking
-.rspec_status
-
-*.swp
-*.dat
-tags
-.DS_Store

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at yoshoku@outlook.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in annoy.gemspec
-gemspec
-
-gem "rake", "~> 12.0"
-gem "rake-compiler"
-gem "rspec", "~> 3.0"

data/Rakefile

@@ -1,14 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-require 'rake/extensiontask'
-
-task :build => :compile
-
-Rake::ExtensionTask.new('annoy') do |ext|
-  ext.lib_dir = 'lib/annoy'
-end
-
-task :default => [:clobber, :compile, :spec]

data/annoy-rb.gemspec

@@ -1,28 +0,0 @@
-require_relative 'lib/annoy/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'annoy-rb'
-  spec.version       = Annoy::VERSION
-  spec.authors       = ['yoshoku']
-  spec.email         = ['yoshoku@outlook.com']
-
-  spec.summary       = 'Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).'
-  spec.description   = 'Annoy.rb is a Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).'
-  spec.homepage      = 'https://github.com/yoshoku/annoy.rb'
-  spec.license       = 'Apache-2.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = 'https://github.com/yoshoku/annoy.rb/blob/main/CHANGELOG.md'
-  spec.metadata['documentation_uri'] = 'https://yoshoku.github.io/annoy.rb/doc/'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-  spec.extensions    = ['ext/annoy/extconf.rb']
-end

data/ext/annoy/annoy.cpp

@@ -1,30 +0,0 @@
-/**
- * Annoy.rb is a Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).
- *
- * Copyright (c) 2020 Atsushi Tatsuma
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#include "annoy.hpp"
-
-extern "C"
-void Init_annoy(void)
-{
-  VALUE rb_mAnnoy = rb_define_module("Annoy");
-  RbAnnoyIndex<AnnoyIndexAngular, double>::define_class(rb_mAnnoy, "AnnoyIndexAngular");
-  RbAnnoyIndex<AnnoyIndexDotProduct, double>::define_class(rb_mAnnoy, "AnnoyIndexDotProduct");
-  RbAnnoyIndex<AnnoyIndexHamming, uint64_t>::define_class(rb_mAnnoy, "AnnoyIndexHamming");
-  RbAnnoyIndex<AnnoyIndexEuclidean, double>::define_class(rb_mAnnoy, "AnnoyIndexEuclidean");
-  RbAnnoyIndex<AnnoyIndexManhattan, double>::define_class(rb_mAnnoy, "AnnoyIndexManhattan");
-}