ngt 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d00cfd25aa3d93228994f1f490c27e5c7bd0566013c6d4af9c9ec22157cd5bf0
-  data.tar.gz: a33f524d222fc6b9c7733039217349e9897926b19854faff58f088a80bb55b58
+  metadata.gz: e6b9362e0da232f074b026b2545275061b9bac6e6124d6927e1bb7d798ac61e1
+  data.tar.gz: afa434689a718d77e944e12c8322258d6e5c064e99545f872c5d6cb1cffa614e
 SHA512:
-  metadata.gz: 1e1431ab3453ce24ab8d3886fc4ce201cc48ec239eb8eb083bb72d9880d8bf554e2e45ce7252e207d7e7da7f10323023364ff1b33ca95ab6bd6795fdbf79e5c0
-  data.tar.gz: 3a932a1da2b75baac08ac477f9e92d1d6f203237f3b94e6962c749d906eb7c63a4a5f0162395f39db21734338ba147a10acb4210cb37d5397d024aef00f32795
+  metadata.gz: 2e676a72eda431ab954a1dcd77e6e7ae2ed843eb3bff1dcc8ae479b1c176a99bfaaa1dd27a6f79ef2f7eca0f6ceb6a35a5bf74a58b38cdda46b676aa0b5adc2d
+  data.tar.gz: ee1b5d27e178712b42ba9d5a6380e0c1d0ea9a9ac6e5941fca60fdd3a4e2ea5d9266f31dfdd79f117fe7fba08bbb92a21d93a363168ca36aa839d303c9e9deae

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.3.0 (2020-03-25)
+
+- Updated NGT to 1.10.0
+- Added support for OpenMP on Mac
+- Create index in memory if no path specified
+- Added `normalized_angle` and `normalized_cosine`
+
 ## 0.2.4 (2020-03-09)
 
 - Updated NGT to 1.9.1

data/README.md

@@ -12,6 +12,12 @@ Add this line to your application’s Gemfile:
 gem 'ngt'
 ```
 
+On Mac, also install OpenMP:
+
+```sh
+brew install libomp
+```
+
 NGT is not available for Windows
 
 ## Getting Started
@@ -118,7 +124,7 @@ Ngt::Index.new(dimensions,
   edge_size_for_creation: 10,
   edge_size_for_search: 40,
   object_type: :float, # :float, :integer
-  distance_type: :l2,  # :l1, :l2, :hamming, :angle, :cosine, or :jaccard
+  distance_type: :l2,  # :l1, :l2, :hamming, :angle, :cosine, :normalized_angle, :normalized_cosine, :jaccard
   path: nil
 )
 ```

data/lib/ngt/ffi.rb

@@ -15,8 +15,11 @@ module Ngt
         :distance, :float
     end
 
+    enum :distance_type, [:l1, :l2, :hamming, :angle, :cosine, :normalized_angle, :normalized_cosine, :jaccard]
+
     attach_function :ngt_open_index, %i[string pointer], :pointer
     attach_function :ngt_create_graph_and_tree, %i[string pointer pointer], :pointer
+    attach_function :ngt_create_graph_and_tree_in_memory, %i[pointer pointer], :pointer
     attach_function :ngt_create_property, %i[pointer], :pointer
     attach_function :ngt_save_index, %i[pointer string pointer], :bool
     attach_function :ngt_get_property, %i[pointer pointer pointer], :bool
@@ -34,23 +37,26 @@ module Ngt
     attach_function :ngt_set_property_distance_type_hamming, %i[pointer pointer], :bool
     attach_function :ngt_set_property_distance_type_jaccard, %i[pointer pointer], :bool
     attach_function :ngt_set_property_distance_type_cosine, %i[pointer pointer], :bool
-    attach_function :ngt_batch_insert_index, %i[pointer pointer uint32 pointer pointer], :bool
-    attach_function :ngt_create_index, %i[pointer uint32 pointer], :bool
-    attach_function :ngt_remove_index, %i[pointer int pointer], :bool
+    attach_function :ngt_set_property_distance_type_normalized_angle, %i[pointer pointer], :bool
+    attach_function :ngt_set_property_distance_type_normalized_cosine, %i[pointer pointer], :bool
     attach_function :ngt_insert_index, %i[pointer pointer uint32 pointer], :int
     attach_function :ngt_insert_index_as_float, %i[pointer pointer uint32 pointer], :int
     attach_function :ngt_create_empty_results, %i[pointer], :pointer
     attach_function :ngt_search_index, %i[pointer pointer int32 size_t float float pointer pointer], :bool
     attach_function :ngt_get_result_size, %i[pointer pointer], :uint32
     attach_function :ngt_get_result, %i[pointer uint32 pointer], ObjectDistance.by_value
+    attach_function :ngt_batch_insert_index, %i[pointer pointer uint32 pointer pointer], :bool
+    attach_function :ngt_create_index, %i[pointer uint32 pointer], :bool
+    attach_function :ngt_remove_index, %i[pointer int pointer], :bool
     attach_function :ngt_get_object_space, %i[pointer pointer], :pointer
     attach_function :ngt_get_object_as_float, %i[pointer int pointer], :pointer
     attach_function :ngt_get_object_as_integer, %i[pointer int pointer], :pointer
+    attach_function :ngt_destroy_results, %i[pointer], :void
     attach_function :ngt_destroy_property, %i[pointer], :void
     attach_function :ngt_close_index, %i[pointer], :void
     attach_function :ngt_get_property_edge_size_for_creation, %i[pointer pointer], :int16
     attach_function :ngt_get_property_edge_size_for_search, %i[pointer pointer], :int16
-    attach_function :ngt_get_property_distance_type, %i[pointer pointer], :int32
+    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_destroy_error_object, %i[pointer], :void

data/lib/ngt/index.rb

@@ -2,34 +2,44 @@ module Ngt
   class Index
     include Utils
 
-    DISTANCE_TYPES = [:l1, :l2, :hamming, :angle, :cosine, :normalized_angle, :normalized_cosine, :jaccard]
+    attr_reader :path
 
-    attr_reader :dimensions, :distance_type, :edge_size_for_creation, :edge_size_for_search, :object_type, :path
-
-    def initialize(path)
+    def initialize(index, path)
+      @index = index
       @path = path
+
       @error = FFI.ngt_create_error_object
-      @index = ffi(:ngt_open_index, path)
+      @property = ffi(:ngt_create_property)
+      ffi(:ngt_get_property, @index, @property)
 
-      property = ffi(:ngt_create_property)
-      ffi(:ngt_get_property, @index, property)
+      ObjectSpace.define_finalizer(self, self.class.finalize(@error, @index, @property))
+    end
 
-      @dimensions = ffi(:ngt_get_property_dimension, property)
-      @distance_type = DISTANCE_TYPES[ffi(:ngt_get_property_distance_type, property)]
-      @edge_size_for_creation = ffi(:ngt_get_property_edge_size_for_creation, property)
-      @edge_size_for_search = ffi(:ngt_get_property_edge_size_for_search, property)
+    def dimensions
+      @dimensions ||= ffi(:ngt_get_property_dimension, @property)
+    end
 
-      object_type = ffi(:ngt_get_property_object_type, property)
-      @float = FFI.ngt_is_property_object_type_float(object_type)
-      @object_type = @float ? :float : :integer
+    def distance_type
+      @distance_type ||= ffi(:ngt_get_property_distance_type, @property)
+    end
 
-      @object_space = ffi(:ngt_get_object_space, @index)
+    def edge_size_for_creation
+      @edge_size_for_creation ||= ffi(:ngt_get_property_edge_size_for_creation, @property)
+    end
+
+    def edge_size_for_search
+      @edge_size_for_search ||= ffi(:ngt_get_property_edge_size_for_search, @property)
+    end
 
-      ObjectSpace.define_finalizer(self, self.class.finalize(@error))
+    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
+      end
     end
 
     def insert(object)
-      ffi(:ngt_insert_index, @index, c_object(object.to_a), @dimensions)
+      ffi(:ngt_insert_index, @index, c_object(object.to_a), dimensions)
     end
 
     def batch_insert(objects, num_threads: 8)
@@ -59,12 +69,12 @@ module Ngt
     end
 
     def object(id)
-      if float?
+      if object_type == :float
         res = ffi(:ngt_get_object_as_float, @object_space, id)
-        res.read_array_of_float(@dimensions)
+        res.read_array_of_float(dimensions)
       else
         res = ffi(:ngt_get_object_as_integer, @object_space, id)
-        res.read_array_of_uint8(@dimensions)
+        res.read_array_of_uint8(dimensions)
       end
     end
 
@@ -75,7 +85,7 @@ 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)
+      ffi(:ngt_search_index, @index, c_object(query.to_a), dimensions, size, epsilon, radius, results)
       result_size = ffi(:ngt_get_result_size, results)
       ret = []
       result_size.times do |i|
@@ -86,12 +96,14 @@ module Ngt
         }
       end
       ret
+    ensure
+      FFI.ngt_destroy_results(results) if results
     end
 
     def save(path2 = nil, path: nil)
       warn "[ngt] Passing path as an option is deprecated - use an argument instead" if path
-      path ||= path2 || @path
-      ffi(:ngt_save_index, @index, path)
+      @path = path || path2 || @path || Dir.mktmpdir
+      ffi(:ngt_save_index, @index, @path)
     end
 
     def close
@@ -101,58 +113,65 @@ module Ngt
     def self.new(dimensions, path: nil, edge_size_for_creation: 10,
         edge_size_for_search: 40, object_type: :float, distance_type: :l2)
 
-      # called from load
-      return super(path) if path && dimensions.nil?
+      error = FFI.ngt_create_error_object
 
-      # TODO remove in 0.3.0
-      create = dimensions.is_a?(Integer) || path
-      unless create
+      # TODO remove in 0.4.0
+      if !dimensions.is_a?(Integer) && !path
         warn "[ngt] Passing a path to new is deprecated - use load instead"
-        return super(dimensions)
+        path = dimensions
+        dimensions = nil
       end
 
-      path ||= Dir.mktmpdir
-      error = FFI.ngt_create_error_object
-      property = ffi(:ngt_create_property, error)
-      ffi(:ngt_set_property_dimension, property, dimensions, error)
-      ffi(:ngt_set_property_edge_size_for_creation, property, edge_size_for_creation, error)
-      ffi(:ngt_set_property_edge_size_for_search, property, edge_size_for_search, error)
-
-      case object_type.to_s.downcase
-      when "float"
-        ffi(:ngt_set_property_object_type_float, property, error)
-      when "integer"
-        ffi(:ngt_set_property_object_type_integer, property, error)
+      if path && dimensions.nil?
+        index = ffi(:ngt_open_index, path, error)
       else
-        raise ArgumentError, "Unknown object type: #{object_type}"
+        property = ffi(:ngt_create_property, error)
+        ffi(:ngt_set_property_dimension, property, dimensions, error)
+        ffi(:ngt_set_property_edge_size_for_creation, property, edge_size_for_creation, error)
+        ffi(:ngt_set_property_edge_size_for_search, property, edge_size_for_search, error)
+
+        case object_type.to_s.downcase
+        when "float"
+          ffi(:ngt_set_property_object_type_float, property, error)
+        when "integer"
+          ffi(:ngt_set_property_object_type_integer, property, error)
+        else
+          raise ArgumentError, "Unknown object type: #{object_type}"
+        end
+
+        case distance_type.to_s.downcase
+        when "l1"
+          ffi(:ngt_set_property_distance_type_l1, property, error)
+        when "l2"
+          ffi(:ngt_set_property_distance_type_l2, property, error)
+        when "angle"
+          ffi(:ngt_set_property_distance_type_angle, property, error)
+        when "hamming"
+          ffi(:ngt_set_property_distance_type_hamming, property, error)
+        when "jaccard"
+          ffi(:ngt_set_property_distance_type_jaccard, property, error)
+        when "cosine"
+          ffi(:ngt_set_property_distance_type_cosine, property, error)
+        when "normalized_angle"
+          ffi(:ngt_set_property_distance_type_normalized_angle, property, error)
+        when "normalized_cosine"
+          ffi(:ngt_set_property_distance_type_normalized_cosine, property, error)
+        else
+          raise ArgumentError, "Unknown distance type: #{distance_type}"
+        end
+
+        index =
+          if path
+            ffi(:ngt_create_graph_and_tree, path, property, error)
+          else
+            ffi(:ngt_create_graph_and_tree_in_memory, property, error)
+          end
       end
 
-      case distance_type.to_s.downcase
-      when "l1"
-        ffi(:ngt_set_property_distance_type_l1, property, error)
-      when "l2"
-        ffi(:ngt_set_property_distance_type_l2, property, error)
-      when "angle"
-        ffi(:ngt_set_property_distance_type_angle, property, error)
-      when "hamming"
-        ffi(:ngt_set_property_distance_type_hamming, property, error)
-      when "jaccard"
-        ffi(:ngt_set_property_distance_type_jaccard, property, error)
-      when "cosine"
-        ffi(:ngt_set_property_distance_type_cosine, property, error)
-      else
-        raise ArgumentError, "Unknown distance type: #{distance_type}"
-      end
-
-      index = ffi(:ngt_create_graph_and_tree, path, property, error)
-      FFI.ngt_close_index(index)
-      index = nil
-
-      super(path)
+      super(index, path)
     ensure
       FFI.ngt_destroy_error_object(error) if error
       FFI.ngt_destroy_property(property) if property
-      FFI.ngt_close_index(index) if index
     end
 
     def self.load(path)
@@ -169,11 +188,12 @@ module Ngt
       Utils.ffi(*args)
     end
 
-    def self.finalize(error)
+    def self.finalize(error, index, property)
       # must use proc instead of stabby lambda
       proc do
-        # TODO clean-up more objects
         FFI.ngt_destroy_error_object(error)
+        FFI.ngt_close_index(index)
+        FFI.ngt_destroy_property(property)
       end
     end
 
@@ -183,10 +203,6 @@ module Ngt
       defined?(Numo::NArray) && data.is_a?(Numo::NArray)
     end
 
-    def float?
-      @float
-    end
-
     def c_object(object)
       c_object = ::FFI::MemoryPointer.new(:double, object.size)
       c_object.write_array_of_double(object)

data/lib/ngt/optimizer.rb

@@ -33,7 +33,12 @@ module Ngt
     private
 
     def path(obj)
-      obj.is_a?(Ngt::Index) ? obj.path : obj
+      if obj.is_a?(Ngt::Index)
+        raise ArgumentError, "Index not saved" unless obj.path
+        obj.path
+      else
+        obj
+      end
     end
   end
 end

data/lib/ngt/version.rb

@@ -1,3 +1,3 @@
 module Ngt
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ngt
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi