annoy-rb 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a7ab55f832f0ce57d4e8c010e69fdcee979764cea2579d5833ae1d3b0c24af9
-  data.tar.gz: 245451b8edd07984b8bcfd515bb1caa75a4164309954d9278aabce76ad9646c2
+  metadata.gz: a8884d4c472560181032959b32eb3396b698dedc7dac7211af67bdb03aaa90f6
+  data.tar.gz: 1eb4acf66b0685e06aed6455c4efd0ffcb17f8805e9b619f003fb62046db41db
 SHA512:
-  metadata.gz: b4c357d55bba00461433a2d63350216eaecb45ab421b2acc5a51a7276eb6922ef58ae1ad6775bd847d56805207e24e23c93944b3e434acdd059bc67d2177e2db
-  data.tar.gz: 4619de7cbde449ba58495ac1a98090cc0c8a6737d31769cb37134f1e351ddc1ad0ade9b4806a9e8d965a1e9272e9df11962f77d5380d6ad0f1819a6ef0dd2164
+  metadata.gz: 0103da7a9f443c4fed168ac61004aa135bbd534edaff6f20d641ef818348288a851370693d75657794c8ebfe9dd45dd54177315c7ac68a3400e43c87dfb1c4bb
+  data.tar.gz: 8e7314fbee4ed318c47848941aba40f6363f350181c616045354af696dc99cbd678c7b999b5bfa35339ad82e6cb3f6782510354d44db5d4d1fb81591128f4822

data/.github/workflows/build.yml

@@ -6,8 +6,9 @@ jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        ruby: [ '2.5', '2.6', '2.7' ]
+        ruby: [ '2.6', '2.7', '3.0' ]
     steps:
       - uses: actions/checkout@v2
       - name: Set upt Ruby ${{ matrix.ruby }}
@@ -16,6 +17,6 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
       - name: Build and test with Rake
         run: |
-          gem install bundler
+          gem install --no-document bundler
           bundle install --jobs 4 --retry 3
           bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 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/Gemfile

@@ -1,8 +1,10 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in annoy.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rake-compiler"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 13.0'
+gem 'rake-compiler', '~> 1.1'
+gem 'rspec', '~> 3.0'
+gem 'rbs', '~> 1.2'
+gem 'steep', '~> 0.44'

data/Rakefile

@@ -7,7 +7,8 @@ require 'rake/extensiontask'
 
 task :build => :compile
 
-Rake::ExtensionTask.new('annoy') do |ext|
+Rake::ExtensionTask.new('annoyext') do |ext|
+  ext.ext_dir = 'ext/annoy'
   ext.lib_dir = 'lib/annoy'
 end
 

data/Steepfile

@@ -0,0 +1,20 @@
+target :lib do
+  signature "sig"
+
+  check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "strong_json"           # Gems
+end
+
+# target :spec do
+#   signature "sig", "sig-private"
+#
+#   check "spec"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "rspec"
+# end

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

@@ -16,10 +16,10 @@
  * limitations under the License.
  */
 
-#include "annoy.hpp"
+#include "annoyext.hpp"
 
 extern "C"
-void Init_annoy(void)
+void Init_annoyext(void)
 {
   VALUE rb_mAnnoy = rb_define_module("Annoy");
   RbAnnoyIndex<AnnoyIndexAngular, double>::define_class(rb_mAnnoy, "AnnoyIndexAngular");

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

@@ -16,8 +16,8 @@
  * limitations under the License.
  */
 
-#ifndef ANNOY_HPP
-#define ANNOY_HPP 1
+#ifndef ANNOYEXT_HPP
+#define ANNOYEXT_HPP 1
 
 #include <typeinfo>
 
@@ -271,8 +271,8 @@ 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 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 +329,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

@@ -6,4 +6,4 @@ $CXXFLAGS << " -std=c++14 -march=native -DANNOYLIB_MULTITHREADED_BUILD"
 $INCFLAGS << " -I$(srcdir)/src"
 $VPATH << "$(srcdir)/src"
 
-create_makefile('annoy/annoy')
+create_makefile('annoy/annoyext')

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.

data/lib/annoy/version.rb

@@ -3,5 +3,5 @@
 # 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.3.0'.freeze
 end

data/sig/annoy.rbs

@@ -0,0 +1,114 @@
+module Annoy
+  VERSION: String
+
+  class AnnoyIndex
+    attr_reader n_features: Integer
+    attr_reader metric: String
+
+    def initialize: (n_features: Integer n_features, ?metric: String metric) -> 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 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 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 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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annoy-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - yoshoku
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-05-23 00:00:00.000000000 Z
 dependencies: []
 description: Annoy.rb is a Ruby binding for the Annoy (Approximate Nearest Neighbors
   Oh Yeah).
@@ -28,15 +28,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - 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/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
@@ -45,7 +47,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/
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -60,8 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).
 test_files: []