ngt 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 056e77fc31169b9c0402c1460eebe72aa3a40ec105d3b7974dcef2b5846c6ed5
-  data.tar.gz: cf99943c13969f7529a6b4371d38f139479bb24015a68382a091bb7446d25a1f
+  metadata.gz: a8a99eccfae3fd0f09f5566ec99d240049e34a4a5ddff73ef26333bad6070932
+  data.tar.gz: ea4dae9eee921e69078ca04eb76c67ceb8c3f00ba368b6c76809a8f98b39478e
 SHA512:
-  metadata.gz: d5a0a3760d14a415e1c16adec206063fd60f3bc0957ccf470e3b588bae4f331d9f9ab7ab80da117e44e25ae6a384d8873228856582f8da6804cce8b72c696188
-  data.tar.gz: 0e78ecd9a477c76a2f77c3ae2242a6886e02daf6ce8c6af99b9e1a50745a38b4f51a91472a936611b383db3f1e176798d4472393250c4d2cd334d8692ddd58ff
+  metadata.gz: 67f096ab1115949bba0606db499790ee6168fada1f06f7b9b46a1631c3f7f2311f9babbdd374afc0dea5dbba5d9a44721f7d8d8a61882c73bc44c043c3f5c258
+  data.tar.gz: 4b44ba3724255e3deb15a52be30a7856ef76f2c47ad5be75a2f9535561058f3dc3dc12a682063054d812f581a266ae423f819ded4fd7c6d1e827c27ca4006595

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.4.2 (2023-07-24)
+
+- Fixed error with `dup` and `clone`
+
+## 0.4.1 (2022-12-08)
+
+- Added support for `:float16` object type
+- Fixed error with `object` method
+
 ## 0.4.0 (2022-06-14)
 
 - Updated NGT to 1.14.6

data/lib/ngt/ffi.rb

@@ -36,8 +36,10 @@ module Ngt
     attach_function :ngt_set_property_edge_size_for_creation, %i[pointer int16_t pointer], :bool
     attach_function :ngt_set_property_edge_size_for_search, %i[pointer int16_t pointer], :bool
     attach_function :ngt_is_property_object_type_float, %i[int32_t], :bool
+    attach_function :ngt_is_property_object_type_float16, %i[int32_t], :bool
     attach_function :ngt_get_property_object_type, %i[pointer pointer], :int32_t
     attach_function :ngt_set_property_object_type_float, %i[pointer pointer], :bool
+    attach_function :ngt_set_property_object_type_float16, %i[pointer pointer], :bool
     attach_function :ngt_set_property_object_type_integer, %i[pointer pointer], :bool
     attach_function :ngt_set_property_distance_type_l1, %i[pointer pointer], :bool
     attach_function :ngt_set_property_distance_type_l2, %i[pointer pointer], :bool
@@ -67,11 +69,21 @@ module Ngt
     attach_function :ngt_get_property_distance_type, %i[pointer pointer], :distance_type
     attach_function :ngt_create_error_object, %i[], :pointer
     attach_function :ngt_get_error_string, %i[pointer], :string
+    attach_function :ngt_clear_error_string, %i[pointer], :void
     attach_function :ngt_destroy_error_object, %i[pointer], :void
     attach_function :ngt_create_optimizer, %i[bool pointer], :pointer
     attach_function :ngt_optimizer_adjust_search_coefficients, %i[pointer string pointer], :bool
     attach_function :ngt_optimizer_execute, %i[pointer string string pointer], :bool
     attach_function :ngt_optimizer_set, %i[pointer int int int float float float float double double pointer], :bool
     attach_function :ngt_destroy_optimizer, %i[pointer], :void
+
+    def self.add_finalizer(pointer, method)
+      ObjectSpace.define_finalizer(pointer, finalize(pointer.to_i, method))
+    end
+
+    def self.finalize(addr, method)
+      # must use proc instead of stabby lambda
+      proc { FFI.send(method, ::FFI::Pointer.new(:pointer, addr)) }
+    end
   end
 end

data/lib/ngt/index.rb

@@ -9,10 +9,11 @@ module Ngt
       @path = path
 
       @error = FFI.ngt_create_error_object
+      FFI.add_finalizer(@error, :ngt_destroy_error_object)
+
       @property = ffi(:ngt_create_property)
+      FFI.add_finalizer(@property, :ngt_destroy_property)
       ffi(:ngt_get_property, @index, @property)
-
-      ObjectSpace.define_finalizer(self, self.class.finalize(@error, @index, @property))
     end
 
     def dimensions
@@ -34,22 +35,34 @@ module Ngt
     def object_type
       @object_type ||= begin
         object_type = ffi(:ngt_get_property_object_type, @property)
-        FFI.ngt_is_property_object_type_float(object_type) ? :float : :integer
+        if FFI.ngt_is_property_object_type_float(object_type)
+          :float
+        elsif FFI.ngt_is_property_object_type_float16(object_type)
+          :float16
+        else
+          :integer
+        end
       end
     end
 
     def insert(object)
-      ffi(:ngt_insert_index, @index, c_object(object.to_a), dimensions)
+      object = object.to_a
+      ffi(:ngt_insert_index, @index, c_object(object), object.size)
     end
 
     def batch_insert(objects, num_threads: 8)
       if narray?(objects)
+        check_dimensions(objects.shape[1])
+
         objects = objects.cast_to(Numo::SFloat) unless objects.is_a?(Numo::SFloat)
         count = objects.shape[0]
         obj = ::FFI::MemoryPointer.new(:char, objects.byte_size)
         obj.write_bytes(objects.to_binary)
       else
         objects = objects.to_a
+        objects.each do |object|
+          check_dimensions(object.size)
+        end
         count = objects.size
         flat_objects = objects.flatten
         obj = ::FFI::MemoryPointer.new(:float, flat_objects.size)
@@ -70,11 +83,13 @@ module Ngt
 
     def object(id)
       if object_type == :float
-        res = ffi(:ngt_get_object_as_float, @object_space, id)
+        res = ffi(:ngt_get_object_as_float, object_space, id)
         res.read_array_of_float(dimensions)
-      else
-        res = ffi(:ngt_get_object_as_integer, @object_space, id)
+      elsif object_type == :integer
+        res = ffi(:ngt_get_object_as_integer, object_space, id)
         res.read_array_of_uint8(dimensions)
+      else
+        raise Error, "Method not supported for this object type"
       end
     end
 
@@ -85,7 +100,8 @@ module Ngt
     def search(query, size: 20, epsilon: 0.1, radius: nil)
       radius ||= -1.0
       results = ffi(:ngt_create_empty_results)
-      ffi(:ngt_search_index, @index, c_object(query.to_a), dimensions, size, epsilon, radius, results)
+      query = query.to_a
+      ffi(:ngt_search_index, @index, c_object(query), query.size, size, epsilon, radius, results)
       result_size = ffi(:ngt_get_result_size, results)
       ret = []
       result_size.times do |i|
@@ -125,6 +141,8 @@ module Ngt
         case object_type.to_s.downcase
         when "float"
           ffi(:ngt_set_property_object_type_float, property, error)
+        when "float16"
+          ffi(:ngt_set_property_object_type_float16, property, error)
         when "integer"
           ffi(:ngt_set_property_object_type_integer, property, error)
         else
@@ -160,6 +178,8 @@ module Ngt
           end
       end
 
+      FFI.add_finalizer(index, :ngt_close_index)
+
       super(index, path)
     ensure
       FFI.ngt_destroy_error_object(error) if error
@@ -180,15 +200,6 @@ module Ngt
       Utils.ffi(*args)
     end
 
-    def self.finalize(error, index, property)
-      # must use proc instead of stabby lambda
-      proc do
-        FFI.ngt_destroy_error_object(error)
-        FFI.ngt_close_index(index)
-        FFI.ngt_destroy_property(property)
-      end
-    end
-
     private
 
     def narray?(data)
@@ -196,9 +207,18 @@ module Ngt
     end
 
     def c_object(object)
+      check_dimensions(object.size)
       c_object = ::FFI::MemoryPointer.new(:double, object.size)
       c_object.write_array_of_double(object)
       c_object
     end
+
+    def check_dimensions(d)
+      raise ArgumentError, "Bad dimensions" if d != dimensions
+    end
+
+    def object_space
+      @object_space ||= ffi(:ngt_get_object_space, @index)
+    end
   end
 end

data/lib/ngt/optimizer.rb

@@ -4,12 +4,13 @@ module Ngt
 
     def initialize(outgoing: 10, incoming: 120, queries: 100, low_accuracy_from: 0.3, low_accuracy_to: 0.5, high_accuracy_from: 0.8, high_accuracy_to: 0.9, gt_epsilon: 0.1, merge: 0.2)
       @error = FFI.ngt_create_error_object
+      FFI.add_finalizer(@error, :ngt_destroy_error_object)
+
       @optimizer = ffi(:ngt_create_optimizer, true)
+      FFI.add_finalizer(@optimizer, :ngt_destroy_optimizer)
 
       ffi(:ngt_optimizer_set, @optimizer, outgoing, incoming, queries, low_accuracy_from,
         low_accuracy_to, high_accuracy_from, high_accuracy_to, gt_epsilon, merge)
-
-      ObjectSpace.define_finalizer(self, self.class.finalize(@optimizer, @error))
     end
 
     def execute(in_index_path, out_index_path)
@@ -20,14 +21,6 @@ module Ngt
       ffi(:ngt_optimizer_adjust_search_coefficients, @optimizer, path(index_path))
     end
 
-    def self.finalize(optimizer, error)
-      # must use proc instead of stabby lambda
-      proc do
-        FFI.ngt_destroy_optimizer(optimizer)
-        FFI.ngt_destroy_error_object(error)
-      end
-    end
-
     private
 
     def path(obj)

data/lib/ngt/utils.rb

@@ -4,7 +4,10 @@ module Ngt
     def self.ffi(method, *args)
       res = FFI.send(method, *args)
       message = FFI.ngt_get_error_string(args.last)
-      raise Error, message unless message.empty?
+      unless message.empty?
+        FFI.ngt_clear_error_string(args.last)
+        raise Error, message
+      end
       res
     end
 

data/lib/ngt/version.rb

@@ -1,3 +1,3 @@
 module Ngt
-  VERSION = "0.4.0"
+  VERSION = "0.4.2"
 end

data/lib/ngt.rb

@@ -5,10 +5,10 @@ require "ffi"
 require "tmpdir"
 
 # modules
-require "ngt/utils"
-require "ngt/index"
-require "ngt/optimizer"
-require "ngt/version"
+require_relative "ngt/utils"
+require_relative "ngt/index"
+require_relative "ngt/optimizer"
+require_relative "ngt/version"
 
 module Ngt
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ngt
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2023-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: High-speed approximate nearest neighbors for Ruby