annoy-rb 0.2.2 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f7232280d8b48fb91e8df376002737365c98025a749ac940c768c8678bbfeed7
4
- data.tar.gz: 2f877a4dbdc4cde3ed5dea581aa1007ca1f7f084a1984b39715b3955311a7e71
3
+ metadata.gz: c8108550b7970bce06a297ee075182f286e451e902ade1254a1c095f05b53d2b
4
+ data.tar.gz: e35e6b247dfec3b21341339a56039ae63267c133ba53f4d6d3004f9acce90d67
5
5
  SHA512:
6
- metadata.gz: 69215b205bb28a0e598232392db21dcafa292f6acda6c163570a5125ee10207d223f673852ffa7de4e92e7a301fc0efaf18399ba411f7f51453f6ef801af3121
7
- data.tar.gz: 6854842c3f9b88252050980c7ed0341993ffae89457c045dcda8fb21cd462af103fd60522df4e69eaf032f73e618a99dcc079a2741a37c86ae4c9d7d2afec385
6
+ metadata.gz: 60fc9c1c02215333eb63b8a6cc2c1228bf97da7da444ea5ba9b930f756ed5f4363f336b96332034d4f391f18e999dbb21c8e2df0dd6bb00a7491ea257d39a2ac
7
+ data.tar.gz: dd63d425a08a94a102e7731c040563a2f788e284b671babb0d9683275c9affcc2119eeb89968f699f642ad8203230e7b821b49ca88a03c9963be9ea66d95b893
@@ -1,21 +1,20 @@
1
1
  name: build
2
2
 
3
- on: [push]
3
+ on: [push, pull_request]
4
4
 
5
5
  jobs:
6
6
  build:
7
7
  runs-on: ubuntu-latest
8
8
  strategy:
9
+ fail-fast: false
9
10
  matrix:
10
- ruby: [ '2.5', '2.6', '2.7' ]
11
+ ruby: [ '2.6', '2.7', '3.0' ]
11
12
  steps:
12
13
  - uses: actions/checkout@v2
13
14
  - name: Set upt Ruby ${{ matrix.ruby }}
14
- uses: actions/setup-ruby@v1
15
+ uses: ruby/setup-ruby@v1
15
16
  with:
16
17
  ruby-version: ${{ matrix.ruby }}
18
+ bundler-cache: true
17
19
  - name: Build and test with Rake
18
- run: |
19
- gem install bundler
20
- bundle install --jobs 4 --retry 3
21
- bundle exec rake
20
+ run: bundle exec rake
data/CHANGELOG.md CHANGED
@@ -1,3 +1,28 @@
1
+ ## 0.5.0
2
+ ### Breaking change
3
+ - Remove `-march=native` and `-DANNOYLIB_MULTITHREADED_BUILD` from CXXFLAGS.
4
+ For example, the installation command to reproduce the same build as the previous version is as follows:
5
+
6
+ ```
7
+ $ gem install annoy-rb -- --with-cxxflags=-march=native -DANNOYLIB_MULTITHREADED_BUILD
8
+ ```
9
+
10
+ ```
11
+ $ bundle config --local build.annoy-rb "--with-cxxflags=-march=native -DANNOYLIB_MULTITHREADED_BUILD"
12
+ $ bundle install
13
+ ```
14
+
15
+ ## 0.4.0
16
+ - Add dummy constructor call at memory allocation of binding class to prevent occuring segment fault on GC when initialize method is failed.
17
+
18
+ ## 0.3.0
19
+ - Add type declaration file: sig/annoy.rbs
20
+ - Fix get_distance method to return integer typed value on hamming metric index.
21
+ - Rename native extension files.
22
+
23
+ ## 0.2.3
24
+ - Add GC guard to index saving and loading methods.
25
+
1
26
  ## 0.2.2
2
27
  - Replace Data_ functions to TypedData_ functions.
3
28
 
data/Gemfile CHANGED
@@ -1,8 +1,10 @@
1
- source "https://rubygems.org"
1
+ source 'https://rubygems.org'
2
2
 
3
3
  # Specify your gem's dependencies in annoy.gemspec
4
4
  gemspec
5
5
 
6
- gem "rake", "~> 12.0"
7
- gem "rake-compiler"
8
- gem "rspec", "~> 3.0"
6
+ gem 'rake', '~> 13.0'
7
+ gem 'rake-compiler', '~> 1.1'
8
+ gem 'rspec', '~> 3.0'
9
+ gem 'rbs', '~> 1.2'
10
+ gem 'steep', '~> 0.44'
data/README.md CHANGED
@@ -2,10 +2,10 @@
2
2
 
3
3
  [![Build Status](https://github.com/yoshoku/annoy.rb/workflows/build/badge.svg)](https://github.com/yoshoku/annoy.rb/actions?query=workflow%3Abuild)
4
4
  [![Gem Version](https://badge.fury.io/rb/annoy-rb.svg)](https://badge.fury.io/rb/annoy-rb)
5
- [![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://github.com/yoshoku/annoy.rb/blob/master/LICENSE.txt)
5
+ [![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://github.com/yoshoku/annoy.rb/blob/main/LICENSE.txt)
6
6
  [![Documentation](http://img.shields.io/badge/api-reference-blue.svg)](https://yoshoku.github.io/annoy.rb/doc/)
7
7
 
8
- Annoy.rb is a Ruby binding for the [Annoy (Approximate Nearest Neighbors Oh Yeah)](https://github.com/spotify/annoy).
8
+ Annoy.rb provides Ruby bindings for the [Annoy (Approximate Nearest Neighbors Oh Yeah)](https://github.com/spotify/annoy).
9
9
 
10
10
  ## Installation
11
11
 
@@ -56,8 +56,6 @@ The gem is available as open source under the terms of the [Apache-2.0 License](
56
56
 
57
57
  ## Contributing
58
58
 
59
- 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/master/CODE_OF_CONDUCT.md).
60
-
61
- ## Code of Conduct
62
-
63
- 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/master/CODE_OF_CONDUCT.md).
59
+ Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/annoy.rb.
60
+ This project is intended to be a safe, welcoming space for collaboration,
61
+ and contributors are expected to adhere to the [code of conduct](https://github.com/yoshoku/annoy.rb/blob/main/CODE_OF_CONDUCT.md).
data/Rakefile CHANGED
@@ -7,7 +7,8 @@ require 'rake/extensiontask'
7
7
 
8
8
  task :build => :compile
9
9
 
10
- Rake::ExtensionTask.new('annoy') do |ext|
10
+ Rake::ExtensionTask.new('annoyext') do |ext|
11
+ ext.ext_dir = 'ext/annoy'
11
12
  ext.lib_dir = 'lib/annoy'
12
13
  end
13
14
 
data/Steepfile ADDED
@@ -0,0 +1,20 @@
1
+ target :lib do
2
+ signature "sig"
3
+
4
+ check "lib" # Directory name
5
+ # check "Gemfile" # File name
6
+ # check "app/models/**/*.rb" # Glob
7
+ # # ignore "lib/templates/*.rb"
8
+ #
9
+ # # library "pathname", "set" # Standard libraries
10
+ # # library "strong_json" # Gems
11
+ end
12
+
13
+ # target :spec do
14
+ # signature "sig", "sig-private"
15
+ #
16
+ # check "spec"
17
+ #
18
+ # # library "pathname", "set" # Standard libraries
19
+ # # library "rspec"
20
+ # end
data/annoy-rb.gemspec CHANGED
@@ -6,14 +6,14 @@ Gem::Specification.new do |spec|
6
6
  spec.authors = ['yoshoku']
7
7
  spec.email = ['yoshoku@outlook.com']
8
8
 
9
- spec.summary = 'Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).'
10
- spec.description = 'Annoy.rb is a Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).'
9
+ spec.summary = 'Ruby bindings for the Annoy (Approximate Nearest Neighbors Oh Yeah).'
10
+ spec.description = 'Annoy.rb provides Ruby bindings for the Annoy (Approximate Nearest Neighbors Oh Yeah).'
11
11
  spec.homepage = 'https://github.com/yoshoku/annoy.rb'
12
12
  spec.license = 'Apache-2.0'
13
13
 
14
14
  spec.metadata['homepage_uri'] = spec.homepage
15
15
  spec.metadata['source_code_uri'] = spec.homepage
16
- spec.metadata['changelog_uri'] = 'https://github.com/yoshoku/annoy.rb/blob/master/CHANGELOG.md'
16
+ spec.metadata['changelog_uri'] = 'https://github.com/yoshoku/annoy.rb/blob/main/CHANGELOG.md'
17
17
  spec.metadata['documentation_uri'] = 'https://yoshoku.github.io/annoy.rb/doc/'
18
18
 
19
19
  # Specify which files should be added to the gem when it is released.
@@ -16,10 +16,10 @@
16
16
  * limitations under the License.
17
17
  */
18
18
 
19
- #include "annoy.hpp"
19
+ #include "annoyext.hpp"
20
20
 
21
21
  extern "C"
22
- void Init_annoy(void)
22
+ void Init_annoyext(void)
23
23
  {
24
24
  VALUE rb_mAnnoy = rb_define_module("Annoy");
25
25
  RbAnnoyIndex<AnnoyIndexAngular, double>::define_class(rb_mAnnoy, "AnnoyIndexAngular");
@@ -16,8 +16,8 @@
16
16
  * limitations under the License.
17
17
  */
18
18
 
19
- #ifndef ANNOY_HPP
20
- #define ANNOY_HPP 1
19
+ #ifndef ANNOYEXT_HPP
20
+ #define ANNOYEXT_HPP 1
21
21
 
22
22
  #include <typeinfo>
23
23
 
@@ -42,6 +42,7 @@ template<class T, typename F> class RbAnnoyIndex
42
42
  public:
43
43
  static VALUE annoy_index_alloc(VALUE self) {
44
44
  T* ptr = (T*)ruby_xmalloc(sizeof(T));
45
+ new (ptr) T();
45
46
  return TypedData_Wrap_Struct(self, &annoy_index_type, ptr);
46
47
  };
47
48
 
@@ -147,6 +148,7 @@ template<class T, typename F> class RbAnnoyIndex
147
148
  rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
148
149
  return Qfalse;
149
150
  }
151
+ RB_GC_GUARD(_filename);
150
152
  return Qtrue;
151
153
  };
152
154
 
@@ -160,6 +162,7 @@ template<class T, typename F> class RbAnnoyIndex
160
162
  rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
161
163
  return Qfalse;
162
164
  }
165
+ RB_GC_GUARD(_filename);
163
166
  return Qtrue;
164
167
  };
165
168
 
@@ -269,8 +272,8 @@ template<class T, typename F> class RbAnnoyIndex
269
272
  static VALUE _annoy_index_get_distance(VALUE self, VALUE _i, VALUE _j) {
270
273
  const int i = NUM2INT(_i);
271
274
  const int j = NUM2INT(_j);
272
- const double dist = get_annoy_index(self)->get_distance(i, j);
273
- return DBL2NUM(dist);
275
+ const F dist = get_annoy_index(self)->get_distance(i, j);
276
+ return typeid(F) == typeid(double) ? DBL2NUM(dist) : UINT2NUM(dist);
274
277
  };
275
278
 
276
279
  static VALUE _annoy_index_get_n_items(VALUE self) {
@@ -292,6 +295,7 @@ template<class T, typename F> class RbAnnoyIndex
292
295
  rb_raise(rb_eRuntimeError, "%s", StringValuePtr(error_str));
293
296
  return Qfalse;
294
297
  }
298
+ RB_GC_GUARD(_filename);
295
299
  return Qtrue;
296
300
  };
297
301
 
@@ -326,4 +330,4 @@ const rb_data_type_t RbAnnoyIndex<T, F>::annoy_index_type = {
326
330
  RUBY_TYPED_FREE_IMMEDIATELY
327
331
  };
328
332
 
329
- #endif /* ANNOY_HPP */
333
+ #endif /* ANNOYEXT_HPP */
data/ext/annoy/extconf.rb CHANGED
@@ -2,8 +2,8 @@ require 'mkmf'
2
2
 
3
3
  abort 'libstdc++ is not found.' unless have_library('stdc++')
4
4
 
5
- $CXXFLAGS << " -std=c++14 -march=native -DANNOYLIB_MULTITHREADED_BUILD"
5
+ $CXXFLAGS << " -std=c++14"
6
6
  $INCFLAGS << " -I$(srcdir)/src"
7
7
  $VPATH << "$(srcdir)/src"
8
8
 
9
- create_makefile('annoy/annoy')
9
+ create_makefile('annoy/annoyext')
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -868,6 +868,8 @@ protected:
868
868
  bool _built;
869
869
  public:
870
870
 
871
+ AnnoyIndex() : _f(0), _fd(0), _nodes(NULL), _n_items(0), _n_nodes(0), _nodes_size(0),
872
+ _is_seeded(false), _loaded(false), _verbose(false), _on_disk(false), _built(false) { }
871
873
  AnnoyIndex(int f) : _f(f) {
872
874
  _s = offsetof(Node, v) + _f * sizeof(T); // Size of each node
873
875
  _verbose = false;
data/lib/annoy/version.rb CHANGED
@@ -3,5 +3,8 @@
3
3
  # Annoy.rb is a Ruby wrapper for Annoy (Approximate Nearest Neighbors Oh Yeah).
4
4
  module Annoy
5
5
  # The version of Annoy.rb you are using.
6
- VERSION = '0.2.2'.freeze
6
+ VERSION = '0.5.0'
7
+
8
+ # The version of Annoy included with gem.
9
+ ANNOY_VERSION = '1.17.0'
7
10
  end
data/lib/annoy.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require 'annoy/version'
4
- require 'annoy/annoy'
4
+ require 'annoy/annoyext'
5
5
 
6
6
  module Annoy
7
7
  # AnnoyIndex is a class that provides functions for k-nearest neighbors search.
data/sig/annoy.rbs ADDED
@@ -0,0 +1,114 @@
1
+ module Annoy
2
+ VERSION: String
3
+
4
+ class AnnoyIndex
5
+ attr_reader n_features: Integer
6
+ attr_reader metric: String
7
+
8
+ def initialize: (n_features: Integer n_features, ?metric: String metric) -> void
9
+ def add_item: (Integer i, Array[Float | Integer] v) -> bool
10
+ def build: (Integer n_trees, ?n_jobs: Integer n_jobs) -> bool
11
+ def save: (String filename, ?prefault: bool prefault) -> bool
12
+ def load: (String filename, ?prefault: bool prefault) -> bool
13
+ def unload: () -> bool
14
+ 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])
15
+ 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])
16
+ def get_item: (Integer i) -> Array[Float | Integer]
17
+ def get_distance: (Integer i, Integer j) -> (Float | Integer)
18
+ def n_items: () -> Integer
19
+ def n_trees: () -> Integer
20
+ def on_disk_build: (String filename) -> bool
21
+ def verbose: (bool flag) -> nil
22
+ def seed: (Integer s) -> nil
23
+ end
24
+
25
+ class AnnoyIndexAngular
26
+ def initialize: (Integer n_features) -> void
27
+ def add_item: (Integer i, Array[Float] v) -> bool
28
+ def build: (Integer n_trees, Integer n_jobs) -> bool
29
+ def save: (String filename, bool prefault) -> bool
30
+ def load: (String filename, bool prefault) -> bool
31
+ def unload: () -> bool
32
+ def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
33
+ def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
34
+ def get_item: (Integer i) -> Array[Float]
35
+ def get_distance: (Integer i, Integer j) -> Float
36
+ def n_items: () -> Integer
37
+ def n_trees: () -> Integer
38
+ def on_disk_build: (String filename) -> bool
39
+ def verbose: (bool flag) -> nil
40
+ def seed: (Integer s) -> nil
41
+ end
42
+
43
+ class AnnoyIndexDotProduct
44
+ def initialize: (Integer n_features) -> void
45
+ def add_item: (Integer i, Array[Float] v) -> bool
46
+ def build: (Integer n_trees, Integer n_jobs) -> bool
47
+ def save: (String filename, bool prefault) -> bool
48
+ def load: (String filename, bool prefault) -> bool
49
+ def unload: () -> bool
50
+ def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
51
+ def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
52
+ def get_item: (Integer i) -> Array[Float]
53
+ def get_distance: (Integer i, Integer j) -> Float
54
+ def n_items: () -> Integer
55
+ def n_trees: () -> Integer
56
+ def on_disk_build: (String filename) -> bool
57
+ def verbose: (bool flag) -> nil
58
+ def seed: (Integer s) -> nil
59
+ end
60
+
61
+ class AnnoyIndexHamming
62
+ def initialize: (Integer n_features) -> void
63
+ def add_item: (Integer i, Array[Integer] v) -> bool
64
+ def build: (Integer n_trees, Integer n_jobs) -> bool
65
+ def save: (String filename, bool prefault) -> bool
66
+ def load: (String filename, bool prefault) -> bool
67
+ def unload: () -> bool
68
+ def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Integer]] | Array[Integer])
69
+ def get_nns_by_vector: (Array[Integer] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Integer]] | Array[Integer])
70
+ def get_item: (Integer i) -> Array[Integer]
71
+ def get_distance: (Integer i, Integer j) -> Integer
72
+ def n_items: () -> Integer
73
+ def n_trees: () -> Integer
74
+ def on_disk_build: (String filename) -> bool
75
+ def verbose: (bool flag) -> nil
76
+ def seed: (Integer s) -> nil
77
+ end
78
+
79
+ class AnnoyIndexEuclidean
80
+ def initialize: (Integer n_features) -> void
81
+ def add_item: (Integer i, Array[Float] v) -> bool
82
+ def build: (Integer n_trees, Integer n_jobs) -> bool
83
+ def save: (String filename, bool prefault) -> bool
84
+ def load: (String filename, bool prefault) -> bool
85
+ def unload: () -> bool
86
+ def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
87
+ def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
88
+ def get_item: (Integer i) -> Array[Float]
89
+ def get_distance: (Integer i, Integer j) -> Float
90
+ def n_items: () -> Integer
91
+ def n_trees: () -> Integer
92
+ def on_disk_build: (String filename) -> bool
93
+ def verbose: (bool flag) -> nil
94
+ def seed: (Integer s) -> nil
95
+ end
96
+
97
+ class AnnoyIndexManhattan
98
+ def initialize: (Integer n_features) -> void
99
+ def add_item: (Integer i, Array[Float] v) -> bool
100
+ def build: (Integer n_trees, Integer n_jobs) -> bool
101
+ def save: (String filename, bool prefault) -> bool
102
+ def load: (String filename, bool prefault) -> bool
103
+ def unload: () -> bool
104
+ def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
105
+ def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
106
+ def get_item: (Integer i) -> Array[Float]
107
+ def get_distance: (Integer i, Integer j) -> Float
108
+ def n_items: () -> Integer
109
+ def n_trees: () -> Integer
110
+ def on_disk_build: (String filename) -> bool
111
+ def verbose: (bool flag) -> nil
112
+ def seed: (Integer s) -> nil
113
+ end
114
+ end
metadata CHANGED
@@ -1,16 +1,16 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: annoy-rb
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.2
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - yoshoku
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2020-11-29 00:00:00.000000000 Z
11
+ date: 2021-11-27 00:00:00.000000000 Z
12
12
  dependencies: []
13
- description: Annoy.rb is a Ruby binding for the Annoy (Approximate Nearest Neighbors
13
+ description: Annoy.rb provides Ruby bindings for the Annoy (Approximate Nearest Neighbors
14
14
  Oh Yeah).
15
15
  email:
16
16
  - yoshoku@outlook.com
@@ -28,22 +28,25 @@ files:
28
28
  - LICENSE.txt
29
29
  - README.md
30
30
  - Rakefile
31
+ - Steepfile
31
32
  - annoy-rb.gemspec
32
- - ext/annoy/annoy.cpp
33
- - ext/annoy/annoy.hpp
33
+ - ext/annoy/annoyext.cpp
34
+ - ext/annoy/annoyext.hpp
34
35
  - ext/annoy/extconf.rb
36
+ - ext/annoy/src/LICENSE
35
37
  - ext/annoy/src/annoylib.h
36
38
  - ext/annoy/src/kissrandom.h
37
39
  - ext/annoy/src/mman.h
38
40
  - lib/annoy.rb
39
41
  - lib/annoy/version.rb
42
+ - sig/annoy.rbs
40
43
  homepage: https://github.com/yoshoku/annoy.rb
41
44
  licenses:
42
45
  - Apache-2.0
43
46
  metadata:
44
47
  homepage_uri: https://github.com/yoshoku/annoy.rb
45
48
  source_code_uri: https://github.com/yoshoku/annoy.rb
46
- changelog_uri: https://github.com/yoshoku/annoy.rb/blob/master/CHANGELOG.md
49
+ changelog_uri: https://github.com/yoshoku/annoy.rb/blob/main/CHANGELOG.md
47
50
  documentation_uri: https://yoshoku.github.io/annoy.rb/doc/
48
51
  post_install_message:
49
52
  rdoc_options: []
@@ -60,8 +63,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
60
63
  - !ruby/object:Gem::Version
61
64
  version: '0'
62
65
  requirements: []
63
- rubygems_version: 3.1.4
66
+ rubygems_version: 3.2.32
64
67
  signing_key:
65
68
  specification_version: 4
66
- summary: Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).
69
+ summary: Ruby bindings for the Annoy (Approximate Nearest Neighbors Oh Yeah).
67
70
  test_files: []