ngt 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 349ccec555d0066d9ccf024a40cf0ecaa478ac628d7cc1240ac2ffa288735a29
-  data.tar.gz: 6242793a35080d8b52c650ebb3b24bee762b36bcf5035bd99263ac2657f3f12c
+  metadata.gz: bff3db4fe839a13d6c1d0c5c959c4e42bf738670c69b0fd4792a1209c7e7165f
+  data.tar.gz: ed3c9d563903be2c8d550bccbeb7efd40cb78b1f5d78e8d6846e9dc4063f78f6
 SHA512:
-  metadata.gz: 9fe092180d1a68e7843089a2a6c1fda1475ca2ad05d302209db501704994b694a5e94ac34daa9898d26efdf739c775741b79e24bd5aa3fbcdd58fb28063c1bef
-  data.tar.gz: 866b54645ab021c69b50967ae5952d159d4e45ff850f450500c550c154a5f9b224ca45e36ead4f4d3ed96d43a26d3ad601040ba91a31671d815789161a981a83
+  metadata.gz: 7e85cd285bac398611fcae5d3bae99f9b13422b1dab068387f787d91b9137eb7ffdf6b96e1d64a5719ce6eef8fef8c2a2e7f8553893ee535f8f9f09ca55ca9b3
+  data.tar.gz: 9645e1859e2c65d88688b23006a94bb272b8ad19c6df64a43427c8842d1e49b26fe3431524c02c74eefacfa0c20360760fb6c31691583190d1d323efb688a7ed

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.3 (2020-03-08)
+
+- Added `load` method
+- Deprecated `create` and passing path to `new`
+
 ## 0.2.2 (2020-02-11)
 
 - Fixed `Could not find NGT` error on some Linux platforms
@@ -11,6 +16,7 @@
 - Changed to Apache 2.0 license to match NGT
 - Added shared libraries
 - Added optimizer
+- Improved performance of `batch_insert` for Numo
 
 ## 0.1.1 (2019-10-27)
 

data/README.md

@@ -29,7 +29,7 @@ objects = [
 Create an index
 
 ```ruby
-index = Ngt::Index.create(path, dimensions)
+index = Ngt::Index.new(dimensions)
 ```
 
 Insert objects
@@ -47,13 +47,13 @@ index.search(query, size: 3)
 Save the index
 
 ```ruby
-index.save
+index.save(path)
 ```
 
 Load an index
 
 ```ruby
-index = Ngt::Index.new(path)
+index = Ngt::Index.load(path)
 ```
 
 Get an object by id
@@ -96,9 +96,8 @@ objects = []
   objects << dim.times.map { rand(100) }
 end
 
-index = Ngt::Index.create("tmp", dim)
+index = Ngt::Index.new(dim)
 index.batch_insert(objects)
-index.save
 
 query = objects[0]
 result = index.search(query, size: 3)

data/lib/ngt.rb

@@ -1,6 +1,9 @@
 # dependencies
 require "ffi"
 
+# stdlib
+require "tmpdir"
+
 # modules
 require "ngt/utils"
 require "ngt/index"

data/lib/ngt/index.rb

@@ -80,8 +80,9 @@ module Ngt
       ret
     end
 
-    def save(path: nil)
-      path ||= @path
+    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)
     end
 
@@ -89,9 +90,20 @@ module Ngt
       FFI.ngt_close_index(@index)
     end
 
-    def self.create(path, dimension, edge_size_for_creation: 10,
+    def self.new(dimension, 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 && dimension.nil?
+
+      # TODO remove in 0.3.0
+      create = dimension.is_a?(Integer) || path
+      unless create
+        warn "[ngt] Passing a path to new is deprecated - use load instead"
+        return super(dimension)
+      end
+
+      path ||= Dir.mktmpdir
       error = FFI.ngt_create_error_object
       property = ffi(:ngt_create_property, error)
       ffi(:ngt_set_property_dimension, property, dimension, error)
@@ -128,13 +140,22 @@ module Ngt
       FFI.ngt_close_index(index)
       index = nil
 
-      Index.new(path)
+      super(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)
+      new(nil, path: path)
+    end
+
+    def self.create(path, dimension, **options)
+      warn "[ngt] create is deprecated - use new instead"
+      new(dimension, path: path, **options)
+    end
+
     # private
     def self.ffi(*args)
       Utils.ffi(*args)

data/lib/ngt/version.rb

@@ -1,3 +1,3 @@
 module Ngt
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

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