annoy-rb 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8108550b7970bce06a297ee075182f286e451e902ade1254a1c095f05b53d2b
-  data.tar.gz: e35e6b247dfec3b21341339a56039ae63267c133ba53f4d6d3004f9acce90d67
+  metadata.gz: 26a73345b4bb8bb29cbfc836599215b38dfa2e61f53bcf8183978802dbafbadc
+  data.tar.gz: fdf69a4b34bd4c1a06cab5a68c54de13ac7a521c079ff9526981c8b13056373b
 SHA512:
-  metadata.gz: 60fc9c1c02215333eb63b8a6cc2c1228bf97da7da444ea5ba9b930f756ed5f4363f336b96332034d4f391f18e999dbb21c8e2df0dd6bb00a7491ea257d39a2ac
-  data.tar.gz: dd63d425a08a94a102e7731c040563a2f788e284b671babb0d9683275c9affcc2119eeb89968f699f642ad8203230e7b821b49ca88a03c9963be9ea66d95b893
+  metadata.gz: 7999995d341e22f10ce89c645b5eaa2a7911812a03e3c04291c28e120bfcec27397930815b8491854a2f65577804a8b7fb50ac6bb7eaba2d7cc1d780c90df711
+  data.tar.gz: b58d1820ce6a48d7bae526afccaefe16770091c9b84b00679517ffeabfde16df5cd70ababc751037b54c3f04a064131614edb852d9c8298a756efa6fc09592e3

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## 0.7.0
+
+- Update bundled Annoy version to 1.17.1.
+- Refactor config files.
+
+## 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.
+
+```
+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.

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)
+[![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/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://github.com/yoshoku/annoy-rb/blob/main/LICENSE.txt)
+[![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,12 +63,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.
+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).
+and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.

data/ext/annoy/annoyext.cpp

@@ -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.
@@ -18,13 +18,16 @@
 
 #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>::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");
+  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");
 }