hnswlib 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7823039ef0a73f79011cbbb4dd8bb90f56549d82c93cee311725a2e728ab8809
-  data.tar.gz: be1846136d1d87c63d3aa49c404f9148c8d04d8c0ba4af65d6297096b5683150
+  metadata.gz: 99f5f1403a51083df75ef842a11b996fe6c159f95c3798f217a076cb5f535254
+  data.tar.gz: f9972ac4e644727a126e937e81494cc11bc051bc7ff0daf57139845aed1e7719
 SHA512:
-  metadata.gz: 5ddd709e8bd403b959c7ab8bc21b17b6e264da0976a2d85a4acd7edeb057b7771d53fac337d3a6dfdd2718dcd499efd2b0f8633170241dd01269cd34753be10a
-  data.tar.gz: 11fd6ee5ca94949665fa30a106e926283c9e190030b47b6b001b0fd755ff5512f8b913b02bb79f1b51cb851c50867d0dca1a861fb2f09b6805e4d0b74bb033b5
+  metadata.gz: c4f96fceab228e3cffd9f2b77e513b86fe71ec3156cdff10c0bc9206ad7951f87c507531088f91f45a940c399102bff6a2dedc5fee8b09b37a5f5739e9a02b6c
+  data.tar.gz: 8297e1e0d1f6753b3e8900b07b80dba271276a14303b102cd8084e480ec491da269baac1fc8be08ab350976fc22cb859583745dc219d73d6f56b33fe7502ac2b

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.4.0] - 2021-09-12
+
+- Add type declaration file.
+
 ## [0.3.0] - 2021-08-08
 
 - Rename `Hnswlib::Index` to `Hnswlib::HnswIndex` (for compatibility, `Hnswlib::Index` has been an alis for `Hnswlib::HnswIndex`).

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem 'rake', '~> 13.0'
 gem 'rake-compiler', '~> 1.1'
 gem 'rspec', '~> 3.0'
+gem 'rbs', '~> 1.2'
+gem 'steep', '~> 0.44'

data/Steepfile

@@ -0,0 +1,27 @@
+# D = Steep::Diagnostic
+#
+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
+#
+#   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+#   # configure_code_diagnostics do |hash|             # You can setup everything yourself
+#   #   hash[D::Ruby::NoMethod] = :information
+#   # end
+end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname", "set"       # Standard libraries
+# end

data/lib/hnswlib/version.rb

@@ -3,7 +3,7 @@
 # Hnswlib.rb provides Ruby bindings for the Hnswlib.
 module Hnswlib
   # The version of Hnswlib.rb you install.
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 
   # The version of Hnswlib included with gem.
   HSWLIB_VERSION = '0.5.2'

data/sig/hnswlib.rbs

@@ -0,0 +1,69 @@
+module Hnswlib
+  VERSION: ::String
+  HSWLIB_VERSION: ::String
+
+  class HnswIndex
+    attr_reader metric: String
+
+    def initialize: (n_features: Integer n_features, max_item: Integer max_item, ?metric: ::String metric, ?m: ::Integer m, ?ef_construction: ::Integer ef_construction, ?random_seed: ::Integer random_seed) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def get_item: (Integer i) -> Array[Float]
+    def remove_item: (Integer i) -> void
+    def get_nns_by_item: (Integer i, Integer n, ?include_distances: (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, ?include_distances: (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def resize_index: (Integer new_max_item) -> void
+    def set_ef: (Integer ef) -> void
+    def save: (String filename) -> void
+    def load: (String filename) -> void
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_features: () -> Integer
+    def max_item: () -> Integer
+  end
+
+  Index: untyped
+
+  class L2Space
+    attr_accessor dim: Integer
+
+    def initialize: (Integer dim) -> void
+    def distance: (Array[Float] a, Array[Float] b) -> Float
+  end
+
+  class InnerProductSpace
+    attr_accessor dim: Integer
+
+    def initialize: (Integer dim) -> void
+    def distance: (Array[Float] a, Array[Float] b) -> Float
+  end
+
+  class BruteforceSearch
+    attr_accessor space: (::Hnswlib::L2Space | ::Hnswlib::InnerProductSpace)
+
+    def initialize: (space: (::Hnswlib::L2Space | ::Hnswlib::InnerProductSpace) space, max_elements: Integer max_elements) -> void
+    def add_point: (Array[Float] arr, Integer idx) -> bool
+    def current_count: () -> Integer
+    def load_index: (String filename) -> void
+    def max_elements: () -> Integer
+    def remove_point: (Integer idx) -> void
+    def save_index: (String filename) -> void
+    def search_knn: (Array[Float] arr, Integer k) -> [Array[Integer], Array[Float]]
+  end
+
+  class HierarchicalNSW
+    attr_accessor space: (::Hnswlib::L2Space | ::Hnswlib::InnerProductSpace)
+
+    def initialize: (space: (::Hnswlib::L2Space | ::Hnswlib::InnerProductSpace) space, max_elements: Integer max_elements, ?m: Integer m, ?ef_construction: Integer ef_construction, ?random_seed: Integer random_seed) -> void
+    def add_point: (Array[Float] arr, Integer idx) -> bool
+    def current_count: () -> Integer
+    def get_ids: () -> Array[Integer]
+    def get_point: (Integer idx) -> Array[Float]
+    def load_index: (String filename) -> void
+    def mark_deleted: (Integer idx) -> void
+    def max_elements: () -> Integer
+    def resize_index: (Integer new_max_elements) -> void
+    def save_index: (String filename) -> void
+    def search_knn: (Array[Float] arr, Integer k) -> [Array[Integer], Array[Float]]
+    def set_ef: (Integer ef) -> void
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hnswlib
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - yoshoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-08 00:00:00.000000000 Z
+date: 2021-09-11 00:00:00.000000000 Z
 dependencies: []
 description: Hnswlib.rb provides Ruby bindings for the Hnswlib.
 email:
@@ -27,6 +27,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - ext/hnswlib/extconf.rb
 - ext/hnswlib/hnswlibext.cpp
 - ext/hnswlib/hnswlibext.hpp
@@ -40,6 +41,7 @@ files:
 - hnswlib.gemspec
 - lib/hnswlib.rb
 - lib/hnswlib/version.rb
+- sig/hnswlib.rbs
 homepage: https://github.com/yoshoku/hnswlib.rb
 licenses:
 - Apache-2.0