annoy-rb 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ae4f03fb87f0ea9ab0ff8ff13eb5c011cfd51931e5b4fc63c9a480560e9b102
-  data.tar.gz: 815d1f92d975ad932cc608a50a0bf983477d4fb3554aec5cd2978d904fe766b1
+  metadata.gz: 504bef50c398d29e30123e694558cbbb9edc5c3958f457ce3b5622e51467decf
+  data.tar.gz: 39965aeddd097635ccdd9e926d2a1b349c294c41a44c2cc5f729c5bc5431d99e
 SHA512:
-  metadata.gz: 2dd6f50030ac181a66633ea63c1e616ddb3b931227ce002d25b8ec5fb5b7d9094e6e0970bb9367bfe63004bce448bdb318658d17bc089d7af2978cdfdc33c776
-  data.tar.gz: f6c5995f2a7986e2c6dfba83bccf3a41b52e564dfce503c4def30395c3c19287422a93d1e62fd5a139e824bf2372910c415cb6cc66c22c41833153790f3bbc1f
+  metadata.gz: 56dfefa366db41856aebc90c23ccbd775bbc0eaf354e80f87568049ff05b039ce07e875da2be6a4e5730415f255d8e972800326a597ce073056803508de1291c
+  data.tar.gz: 353473a64ffcae0beb9f0d4af7eb6fac85404f3103ad325ece10d7a59813b5eb778e98195d16801036fc167a118d408e4cfd58825c954db077c0234927faf3d2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.6.1
+
+- Refactor codes and configs with RuboCop and clang-format.
+
 ## 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.

data/README.md

@@ -1,11 +1,11 @@
-# Annoy.rb
+# annoy-rb
 
 [![Build Status](https://github.com/yoshoku/annoy.rb/workflows/build/badge.svg)](https://github.com/yoshoku/annoy.rb/actions?query=workflow%3Abuild)
 [![Gem Version](https://badge.fury.io/rb/annoy-rb.svg)](https://badge.fury.io/rb/annoy-rb)
 [![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/)
+[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://yoshoku.github.io/annoy.rb/doc/)
 
-Annoy.rb provides Ruby bindings 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
 
@@ -23,11 +23,24 @@ Or install it yourself as:
 
     $ gem install annoy-rb
 
-Note: Annoy.rb does not require the installation of another external library.
+Note: annoy-rb does not require the installation of another external library.
+In addition, annoy-rb does not give any optimization options when building native extensions.
+If necessary, add optimization options yourself during installation, as follows;
+
+```
+$ bundle config --local build.annoy-rb "--with-cxxflags=-march=native"
+$ bundle install
+```
+
+Or:
+
+```
+$ gem install annoy-rb -- --with-cxxflags=-march=native
+```
 
 ## Documentation
 
-* [Annoy.rb API Documentation](https://yoshoku.github.io/annoy.rb/doc/)
+* [annoy-rb API Documentation](https://yoshoku.github.io/annoy.rb/doc/)
 
 ## Usage
 
@@ -50,7 +63,7 @@ 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.
+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.
 
@@ -70,4 +83,4 @@ The gem is available as open source under the terms of the [Apache-2.0 License](
 
 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.
+and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.

data/ext/annoy/annoyext.cpp

@@ -18,9 +18,7 @@
 
 #include "annoyext.hpp"
 
-extern "C"
-void Init_annoyext(void)
-{
+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");

data/ext/annoy/annoyext.hpp

@@ -22,301 +22,304 @@
 #include <typeinfo>
 
 #include <ruby.h>
+
 #include <annoylib.h>
 #include <kissrandom.h>
 
 #ifdef ANNOYLIB_MULTITHREADED_BUILD
-  typedef AnnoyIndexMultiThreadedBuildPolicy AnnoyIndexThreadedBuildPolicy;
+typedef AnnoyIndexMultiThreadedBuildPolicy AnnoyIndexThreadedBuildPolicy;
 #else
-  typedef AnnoyIndexSingleThreadedBuildPolicy AnnoyIndexThreadedBuildPolicy;
+typedef AnnoyIndexSingleThreadedBuildPolicy AnnoyIndexThreadedBuildPolicy;
 #endif
 
+// clang-format off
 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);
-    };
-
-    static void annoy_index_free(void* ptr) {
-      ((T*)ptr)->~AnnoyIndex();
-      ruby_xfree(ptr);
-    };
-
-    static size_t annoy_index_size(const void* ptr) {
-      return sizeof(*((T*)ptr));
-    };
-
-    static T* get_annoy_index(VALUE self) {
-      T* ptr;
-      TypedData_Get_Struct(self, T, &annoy_index_type, ptr);
-      return ptr;
-    };
-
-    static VALUE define_class(VALUE rb_mAnnoy, const char* class_name) {
-      VALUE rb_cAnnoyIndex = rb_define_class_under(rb_mAnnoy, class_name, rb_cObject);
-      rb_define_alloc_func(rb_cAnnoyIndex, annoy_index_alloc);
-      rb_define_method(rb_cAnnoyIndex, "initialize", RUBY_METHOD_FUNC(_annoy_index_init), 1);
-      rb_define_method(rb_cAnnoyIndex, "add_item", RUBY_METHOD_FUNC(_annoy_index_add_item), 2);
-      rb_define_method(rb_cAnnoyIndex, "build", RUBY_METHOD_FUNC(_annoy_index_build), 2);
-      rb_define_method(rb_cAnnoyIndex, "save", RUBY_METHOD_FUNC(_annoy_index_save), 2);
-      rb_define_method(rb_cAnnoyIndex, "load", RUBY_METHOD_FUNC(_annoy_index_load), 2);
-      rb_define_method(rb_cAnnoyIndex, "unload", RUBY_METHOD_FUNC(_annoy_index_unload), 0);
-      rb_define_method(rb_cAnnoyIndex, "get_nns_by_item", RUBY_METHOD_FUNC(_annoy_index_get_nns_by_item), 4);
-      rb_define_method(rb_cAnnoyIndex, "get_nns_by_vector", RUBY_METHOD_FUNC(_annoy_index_get_nns_by_vector), 4);
-      rb_define_method(rb_cAnnoyIndex, "get_item", RUBY_METHOD_FUNC(_annoy_index_get_item), 1);
-      rb_define_method(rb_cAnnoyIndex, "get_distance", RUBY_METHOD_FUNC(_annoy_index_get_distance), 2);
-      rb_define_method(rb_cAnnoyIndex, "get_n_items", RUBY_METHOD_FUNC(_annoy_index_get_n_items), 0);
-      rb_define_method(rb_cAnnoyIndex, "get_n_trees", RUBY_METHOD_FUNC(_annoy_index_get_n_trees), 0);
-      rb_define_method(rb_cAnnoyIndex, "on_disk_build", RUBY_METHOD_FUNC(_annoy_index_on_disk_build), 1);
-      rb_define_method(rb_cAnnoyIndex, "set_seed", RUBY_METHOD_FUNC(_annoy_index_set_seed), 1);
-      rb_define_method(rb_cAnnoyIndex, "verbose", RUBY_METHOD_FUNC(_annoy_index_verbose), 1);
-      rb_define_method(rb_cAnnoyIndex, "get_f", RUBY_METHOD_FUNC(_annoy_index_get_f), 0);
-      return rb_cAnnoyIndex;
-    };
-
-  private:
-    static const rb_data_type_t annoy_index_type;
-
-    static VALUE _annoy_index_init(VALUE self, VALUE _n_dims) {
-      const int n_dims = NUM2INT(_n_dims);
-      T* ptr = get_annoy_index(self);
-      new (ptr) T(n_dims);
-      return Qnil;
-    };
-
-    static VALUE _annoy_index_add_item(VALUE self, VALUE _idx, VALUE arr) {
-      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)) {
-        rb_raise(rb_eArgError, "Expect item vector to be Array.");
-        return Qfalse;
-      }
-
-      if (n_dims != RARRAY_LEN(arr)) {
-        rb_raise(rb_eArgError, "Array size does not match to index dimensionality.");
-        return Qfalse;
-      }
-
-      F* vec = (F*)ruby_xmalloc(n_dims * sizeof(F));
-      for (int i = 0; i < n_dims; i++) {
-        vec[i] = typeid(F) == typeid(double) ? NUM2DBL(rb_ary_entry(arr, i)) : NUM2UINT(rb_ary_entry(arr, i));
-      }
-
-      char* error;
-      if (!get_annoy_index(self)->add_item(idx, vec, &error)) {
-        VALUE error_str = rb_str_new_cstr(error);
-        free(error);
-        ruby_xfree(vec);
-        rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
-        return Qfalse;
-      }
-
+// clang-format on
+
+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);
+  };
+
+  static void annoy_index_free(void* ptr) {
+    ((T*)ptr)->~AnnoyIndex();
+    ruby_xfree(ptr);
+  };
+
+  static size_t annoy_index_size(const void* ptr) { return sizeof(*((T*)ptr)); };
+
+  static T* get_annoy_index(VALUE self) {
+    T* ptr;
+    TypedData_Get_Struct(self, T, &annoy_index_type, ptr);
+    return ptr;
+  };
+
+  static VALUE define_class(VALUE rb_mAnnoy, const char* class_name) {
+    VALUE rb_cAnnoyIndex = rb_define_class_under(rb_mAnnoy, class_name, rb_cObject);
+    rb_define_alloc_func(rb_cAnnoyIndex, annoy_index_alloc);
+    rb_define_method(rb_cAnnoyIndex, "initialize", RUBY_METHOD_FUNC(_annoy_index_init), 1);
+    rb_define_method(rb_cAnnoyIndex, "add_item", RUBY_METHOD_FUNC(_annoy_index_add_item), 2);
+    rb_define_method(rb_cAnnoyIndex, "build", RUBY_METHOD_FUNC(_annoy_index_build), 2);
+    rb_define_method(rb_cAnnoyIndex, "save", RUBY_METHOD_FUNC(_annoy_index_save), 2);
+    rb_define_method(rb_cAnnoyIndex, "load", RUBY_METHOD_FUNC(_annoy_index_load), 2);
+    rb_define_method(rb_cAnnoyIndex, "unload", RUBY_METHOD_FUNC(_annoy_index_unload), 0);
+    rb_define_method(rb_cAnnoyIndex, "get_nns_by_item", RUBY_METHOD_FUNC(_annoy_index_get_nns_by_item), 4);
+    rb_define_method(rb_cAnnoyIndex, "get_nns_by_vector", RUBY_METHOD_FUNC(_annoy_index_get_nns_by_vector), 4);
+    rb_define_method(rb_cAnnoyIndex, "get_item", RUBY_METHOD_FUNC(_annoy_index_get_item), 1);
+    rb_define_method(rb_cAnnoyIndex, "get_distance", RUBY_METHOD_FUNC(_annoy_index_get_distance), 2);
+    rb_define_method(rb_cAnnoyIndex, "get_n_items", RUBY_METHOD_FUNC(_annoy_index_get_n_items), 0);
+    rb_define_method(rb_cAnnoyIndex, "get_n_trees", RUBY_METHOD_FUNC(_annoy_index_get_n_trees), 0);
+    rb_define_method(rb_cAnnoyIndex, "on_disk_build", RUBY_METHOD_FUNC(_annoy_index_on_disk_build), 1);
+    rb_define_method(rb_cAnnoyIndex, "set_seed", RUBY_METHOD_FUNC(_annoy_index_set_seed), 1);
+    rb_define_method(rb_cAnnoyIndex, "verbose", RUBY_METHOD_FUNC(_annoy_index_verbose), 1);
+    rb_define_method(rb_cAnnoyIndex, "get_f", RUBY_METHOD_FUNC(_annoy_index_get_f), 0);
+    return rb_cAnnoyIndex;
+  };
+
+private:
+  static const rb_data_type_t annoy_index_type;
+
+  static VALUE _annoy_index_init(VALUE self, VALUE _n_dims) {
+    const int n_dims = NUM2INT(_n_dims);
+    T* ptr = get_annoy_index(self);
+    new (ptr) T(n_dims);
+    return Qnil;
+  };
+
+  static VALUE _annoy_index_add_item(VALUE self, VALUE _idx, VALUE arr) {
+    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)) {
+      rb_raise(rb_eArgError, "Expect item vector to be Array.");
+      return Qfalse;
+    }
+
+    if (n_dims != RARRAY_LEN(arr)) {
+      rb_raise(rb_eArgError, "Array size does not match to index dimensionality.");
+      return Qfalse;
+    }
+
+    F* vec = (F*)ruby_xmalloc(n_dims * sizeof(F));
+    for (int i = 0; i < n_dims; i++) {
+      vec[i] = typeid(F) == typeid(double) ? NUM2DBL(rb_ary_entry(arr, i)) : NUM2UINT(rb_ary_entry(arr, i));
+    }
+
+    char* error;
+    if (!get_annoy_index(self)->add_item(idx, vec, &error)) {
+      VALUE error_str = rb_str_new_cstr(error);
+      free(error);
       ruby_xfree(vec);
-      return Qtrue;
-    };
-
-    static VALUE _annoy_index_build(VALUE self, VALUE _n_trees, VALUE _n_jobs) {
-      const int n_trees = NUM2INT(_n_trees);
-      const int n_jobs = NUM2INT(_n_jobs);
-      char* error;
-      if (!get_annoy_index(self)->build(n_trees, n_jobs, &error)) {
-        VALUE error_str = rb_str_new_cstr(error);
-        free(error);
-        rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
-        return Qfalse;
+      rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
+      return Qfalse;
+    }
+
+    ruby_xfree(vec);
+    return Qtrue;
+  };
+
+  static VALUE _annoy_index_build(VALUE self, VALUE _n_trees, VALUE _n_jobs) {
+    const int n_trees = NUM2INT(_n_trees);
+    const int n_jobs = NUM2INT(_n_jobs);
+    char* error;
+    if (!get_annoy_index(self)->build(n_trees, n_jobs, &error)) {
+      VALUE error_str = rb_str_new_cstr(error);
+      free(error);
+      rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
+      return Qfalse;
+    }
+    return Qtrue;
+  };
+
+  static VALUE _annoy_index_save(VALUE self, VALUE _filename, VALUE _prefault) {
+    const char* filename = StringValuePtr(_filename);
+    const bool prefault = _prefault == Qtrue ? true : false;
+    char* error;
+    if (!get_annoy_index(self)->save(filename, prefault, &error)) {
+      VALUE error_str = rb_str_new_cstr(error);
+      free(error);
+      rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
+      return Qfalse;
+    }
+    RB_GC_GUARD(_filename);
+    return Qtrue;
+  };
+
+  static VALUE _annoy_index_load(VALUE self, VALUE _filename, VALUE _prefault) {
+    const char* filename = StringValuePtr(_filename);
+    const bool prefault = _prefault == Qtrue ? true : false;
+    char* error;
+    if (!get_annoy_index(self)->load(filename, prefault, &error)) {
+      VALUE error_str = rb_str_new_cstr(error);
+      free(error);
+      rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
+      return Qfalse;
+    }
+    RB_GC_GUARD(_filename);
+    return Qtrue;
+  };
+
+  static VALUE _annoy_index_unload(VALUE self) {
+    get_annoy_index(self)->unload();
+    return Qnil;
+  };
+
+  static VALUE _annoy_index_get_nns_by_item(VALUE self, VALUE _idx, VALUE _n_neighbors, VALUE _search_k,
+                                            VALUE _include_distances) {
+    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<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);
+
+    const int sz_neighbors = neighbors.size();
+    VALUE neighbors_arr = rb_ary_new2(sz_neighbors);
+
+    for (int i = 0; i < sz_neighbors; i++) {
+      rb_ary_store(neighbors_arr, i, INT2NUM((int)(neighbors[i])));
+    }
+
+    if (include_distances) {
+      const int sz_distances = distances.size();
+      VALUE distances_arr = rb_ary_new2(sz_distances);
+      for (int i = 0; i < sz_distances; i++) {
+        rb_ary_store(distances_arr, i, typeid(F) == typeid(double) ? DBL2NUM(distances[i]) : UINT2NUM(distances[i]));
       }
-      return Qtrue;
-    };
-
-    static VALUE _annoy_index_save(VALUE self, VALUE _filename, VALUE _prefault) {
-      const char* filename = StringValuePtr(_filename);
-      const bool prefault = _prefault == Qtrue ? true : false;
-      char* error;
-      if (!get_annoy_index(self)->save(filename, prefault, &error)) {
-        VALUE error_str = rb_str_new_cstr(error);
-        free(error);
-        rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
-        return Qfalse;
-      }
-      RB_GC_GUARD(_filename);
-      return Qtrue;
-    };
-
-    static VALUE _annoy_index_load(VALUE self, VALUE _filename, VALUE _prefault) {
-      const char* filename = StringValuePtr(_filename);
-      const bool prefault = _prefault == Qtrue ? true : false;
-      char* error;
-      if (!get_annoy_index(self)->load(filename, prefault, &error)) {
-        VALUE error_str = rb_str_new_cstr(error);
-        free(error);
-        rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
-        return Qfalse;
-      }
-      RB_GC_GUARD(_filename);
-      return Qtrue;
-    };
-
-    static VALUE _annoy_index_unload(VALUE self) {
-      get_annoy_index(self)->unload();
-      return Qnil;
-    };
-
-    static VALUE _annoy_index_get_nns_by_item(VALUE self, VALUE _idx, VALUE _n_neighbors, VALUE _search_k, VALUE _include_distances) {
-      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<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);
-
-      const int sz_neighbors = neighbors.size();
-      VALUE neighbors_arr = rb_ary_new2(sz_neighbors);
-
-      for (int i = 0; i < sz_neighbors; i++) {
-        rb_ary_store(neighbors_arr, i, INT2NUM((int)(neighbors[i])));
-      }
-
-      if (include_distances) {
-        const int sz_distances = distances.size();
-        VALUE distances_arr = rb_ary_new2(sz_distances);
-        for (int i = 0; i < sz_distances; i++) {
-          rb_ary_store(distances_arr, i, typeid(F) == typeid(double) ? DBL2NUM(distances[i]) : UINT2NUM(distances[i]));
-        }
-        VALUE res = rb_ary_new2(2);
-        rb_ary_store(res, 0, neighbors_arr);
-        rb_ary_store(res, 1, distances_arr);
-        return res;
-      }
-
-      return neighbors_arr;
-    };
-
-    static VALUE _annoy_index_get_nns_by_vector(VALUE self, VALUE _vec, VALUE _n_neighbors, VALUE _search_k, VALUE _include_distances) {
-      const int n_dims = get_annoy_index(self)->get_f();
-
-      if (!RB_TYPE_P(_vec, T_ARRAY)) {
-        rb_raise(rb_eArgError, "Expect item vector to be Array.");
-        return Qfalse;
-      }
-
-      if (n_dims != RARRAY_LEN(_vec)) {
-        rb_raise(rb_eArgError, "Array size does not match to index dimensionality.");
-        return Qfalse;
-      }
-
-      F* vec = (F*)ruby_xmalloc(n_dims * sizeof(F));
-      for (int i = 0; i < n_dims; i++) {
-        vec[i] = typeid(F) == typeid(double) ? NUM2DBL(rb_ary_entry(_vec, i)) : NUM2UINT(rb_ary_entry(_vec, i));
-      }
-
-      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<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);
-
-      ruby_xfree(vec);
-
-      const int sz_neighbors = neighbors.size();
-      VALUE neighbors_arr = rb_ary_new2(sz_neighbors);
-
-      for (int i = 0; i < sz_neighbors; i++) {
-        rb_ary_store(neighbors_arr, i, INT2NUM((int)(neighbors[i])));
-      }
-
-      if (include_distances) {
-        const int sz_distances = distances.size();
-        VALUE distances_arr = rb_ary_new2(sz_distances);
-        for (int i = 0; i < sz_distances; i++) {
-          rb_ary_store(distances_arr, i, typeid(F) == typeid(double) ? DBL2NUM(distances[i]) : UINT2NUM(distances[i]));
-        }
-        VALUE res = rb_ary_new2(2);
-        rb_ary_store(res, 0, neighbors_arr);
-        rb_ary_store(res, 1, distances_arr);
-        return res;
-      }
-
-      return neighbors_arr;
-    };
-
-    static VALUE _annoy_index_get_item(VALUE self, VALUE _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);
-
-      get_annoy_index(self)->get_item(idx, vec);
-
-      for (int i = 0; i < n_dims; i++) {
-        rb_ary_store(arr, i, typeid(F) == typeid(double) ? DBL2NUM(vec[i]) : UINT2NUM(vec[i]));
-      }
-
-      ruby_xfree(vec);
-      return arr;
-    };
-
-    static VALUE _annoy_index_get_distance(VALUE self, VALUE _i, VALUE _j) {
-      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) {
-      const int32_t n_items = get_annoy_index(self)->get_n_items();
-      return INT2NUM(n_items);
-    };
-
-    static VALUE _annoy_index_get_n_trees(VALUE self) {
-      const int32_t n_trees = get_annoy_index(self)->get_n_trees();
-      return INT2NUM(n_trees);
-    };
-
-    static VALUE _annoy_index_on_disk_build(VALUE self, VALUE _filename) {
-      const char* filename = StringValuePtr(_filename);
-      char* error;
-      if (!get_annoy_index(self)->on_disk_build(filename, &error)) {
-        VALUE error_str = rb_str_new_cstr(error);
-        free(error);
-        rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
-        return Qfalse;
+      VALUE res = rb_ary_new2(2);
+      rb_ary_store(res, 0, neighbors_arr);
+      rb_ary_store(res, 1, distances_arr);
+      return res;
+    }
+
+    return neighbors_arr;
+  };
+
+  static VALUE _annoy_index_get_nns_by_vector(VALUE self, VALUE _vec, VALUE _n_neighbors, VALUE _search_k,
+                                              VALUE _include_distances) {
+    const int n_dims = get_annoy_index(self)->get_f();
+
+    if (!RB_TYPE_P(_vec, T_ARRAY)) {
+      rb_raise(rb_eArgError, "Expect item vector to be Array.");
+      return Qfalse;
+    }
+
+    if (n_dims != RARRAY_LEN(_vec)) {
+      rb_raise(rb_eArgError, "Array size does not match to index dimensionality.");
+      return Qfalse;
+    }
+
+    F* vec = (F*)ruby_xmalloc(n_dims * sizeof(F));
+    for (int i = 0; i < n_dims; i++) {
+      vec[i] = typeid(F) == typeid(double) ? NUM2DBL(rb_ary_entry(_vec, i)) : NUM2UINT(rb_ary_entry(_vec, i));
+    }
+
+    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<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);
+
+    ruby_xfree(vec);
+
+    const int sz_neighbors = neighbors.size();
+    VALUE neighbors_arr = rb_ary_new2(sz_neighbors);
+
+    for (int i = 0; i < sz_neighbors; i++) {
+      rb_ary_store(neighbors_arr, i, INT2NUM((int)(neighbors[i])));
+    }
+
+    if (include_distances) {
+      const int sz_distances = distances.size();
+      VALUE distances_arr = rb_ary_new2(sz_distances);
+      for (int i = 0; i < sz_distances; i++) {
+        rb_ary_store(distances_arr, i, typeid(F) == typeid(double) ? DBL2NUM(distances[i]) : UINT2NUM(distances[i]));
       }
-      RB_GC_GUARD(_filename);
-      return Qtrue;
-    };
-
-    static VALUE _annoy_index_set_seed(VALUE self, VALUE _seed) {
-      const int seed = NUM2INT(_seed);
-      get_annoy_index(self)->set_seed(seed);
-      return Qnil;
-    };
-
-    static VALUE _annoy_index_verbose(VALUE self, VALUE _flag) {
-      const bool flag = _flag == Qtrue ? true : false;
-      get_annoy_index(self)->verbose(flag);
-      return Qnil;
-    };
-
-    static VALUE _annoy_index_get_f(VALUE self) {
-      const int32_t f = get_annoy_index(self)->get_f();
-      return INT2NUM(f);
-    };
+      VALUE res = rb_ary_new2(2);
+      rb_ary_store(res, 0, neighbors_arr);
+      rb_ary_store(res, 1, distances_arr);
+      return res;
+    }
+
+    return neighbors_arr;
+  };
+
+  static VALUE _annoy_index_get_item(VALUE self, VALUE _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);
+
+    get_annoy_index(self)->get_item(idx, vec);
+
+    for (int i = 0; i < n_dims; i++) {
+      rb_ary_store(arr, i, typeid(F) == typeid(double) ? DBL2NUM(vec[i]) : UINT2NUM(vec[i]));
+    }
+
+    ruby_xfree(vec);
+    return arr;
+  };
+
+  static VALUE _annoy_index_get_distance(VALUE self, VALUE _i, VALUE _j) {
+    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) {
+    const int32_t n_items = get_annoy_index(self)->get_n_items();
+    return INT2NUM(n_items);
+  };
+
+  static VALUE _annoy_index_get_n_trees(VALUE self) {
+    const int32_t n_trees = get_annoy_index(self)->get_n_trees();
+    return INT2NUM(n_trees);
+  };
+
+  static VALUE _annoy_index_on_disk_build(VALUE self, VALUE _filename) {
+    const char* filename = StringValuePtr(_filename);
+    char* error;
+    if (!get_annoy_index(self)->on_disk_build(filename, &error)) {
+      VALUE error_str = rb_str_new_cstr(error);
+      free(error);
+      rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
+      return Qfalse;
+    }
+    RB_GC_GUARD(_filename);
+    return Qtrue;
+  };
+
+  static VALUE _annoy_index_set_seed(VALUE self, VALUE _seed) {
+    const int seed = NUM2INT(_seed);
+    get_annoy_index(self)->set_seed(seed);
+    return Qnil;
+  };
+
+  static VALUE _annoy_index_verbose(VALUE self, VALUE _flag) {
+    const bool flag = _flag == Qtrue ? true : false;
+    get_annoy_index(self)->verbose(flag);
+    return Qnil;
+  };
+
+  static VALUE _annoy_index_get_f(VALUE self) {
+    const int32_t f = get_annoy_index(self)->get_f();
+    return INT2NUM(f);
+  };
 };
 
+// clang-format off
 template<class T, typename F>
 const rb_data_type_t RbAnnoyIndex<T, F>::annoy_index_type = {
   "RbAnnoyIndex",
@@ -329,5 +332,6 @@ const rb_data_type_t RbAnnoyIndex<T, F>::annoy_index_type = {
   NULL,
   RUBY_TYPED_FREE_IMMEDIATELY
 };
+// clang-format on
 
 #endif /* ANNOYEXT_HPP */

data/lib/annoy/version.rb

@@ -3,7 +3,7 @@
 # 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.6.0'
+  VERSION = '0.6.1'
 
   # The version of Annoy included with gem.
   ANNOY_VERSION = '1.17.0'

data/lib/annoy-rb.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'annoy'

data/lib/annoy.rb

@@ -40,13 +40,14 @@ module Annoy
     # @param metric [String] The distance metric between vectors ('angular', 'dot', 'hamming', 'euclidean', or 'manhattan').
     # @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')
+    def initialize(n_features:, metric: 'angular', dtype: 'float64') # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
       raise ArgumentError, 'Expect n_features to be Integer.' unless n_features.is_a?(Numeric)
 
       @n_features = n_features.to_i
       @metric = metric
       @dtype = dtype
 
+      # rubocop:disable Layout/LineLength
       @index = case @metric
                when 'angular'
                  @dtype == 'float64' ? AnnoyIndexAngular.new(@n_features) : AnnoyIndexAngularFloat32.new(@n_features)
@@ -62,6 +63,7 @@ module Annoy
                else
                  raise ArgumentError, "No such metric: #{@metric}."
                end
+      # rubocop:enable Layout/LineLength
     end
 
     # Add item to be indexed.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annoy-rb
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - yoshoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-23 00:00:00.000000000 Z
+date: 2022-05-22 00:00:00.000000000 Z
 dependencies: []
 description: Annoy.rb provides Ruby bindings for the Annoy (Approximate Nearest Neighbors
   Oh Yeah).
@@ -29,6 +29,7 @@ files:
 - ext/annoy/src/annoylib.h
 - ext/annoy/src/kissrandom.h
 - ext/annoy/src/mman.h
+- lib/annoy-rb.rb
 - lib/annoy.rb
 - lib/annoy/version.rb
 - sig/annoy.rbs
@@ -40,6 +41,7 @@ metadata:
   source_code_uri: https://github.com/yoshoku/annoy.rb
   changelog_uri: https://github.com/yoshoku/annoy.rb/blob/main/CHANGELOG.md
   documentation_uri: https://yoshoku.github.io/annoy.rb/doc/
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -55,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Ruby bindings for the Annoy (Approximate Nearest Neighbors Oh Yeah).