annoy-rb 0.1.0 → 0.3.0

data/ext/annoy/src/mman.h

@@ -0,0 +1,242 @@
+
+// This is from https://code.google.com/p/mman-win32/
+// 
+// Licensed under MIT
+
+#ifndef _MMAN_WIN32_H
+#define _MMAN_WIN32_H
+
+#ifndef _WIN32_WINNT		// Allow use of features specific to Windows XP or later.                   
+#define _WIN32_WINNT 0x0501	// Change this to the appropriate value to target other versions of Windows.
+#endif						
+
+#include <sys/types.h>
+#include <windows.h>
+#include <errno.h>
+#include <io.h>
+
+#define PROT_NONE       0
+#define PROT_READ       1
+#define PROT_WRITE      2
+#define PROT_EXEC       4
+
+#define MAP_FILE        0
+#define MAP_SHARED      1
+#define MAP_PRIVATE     2
+#define MAP_TYPE        0xf
+#define MAP_FIXED       0x10
+#define MAP_ANONYMOUS   0x20
+#define MAP_ANON        MAP_ANONYMOUS
+
+#define MAP_FAILED      ((void *)-1)
+
+/* Flags for msync. */
+#define MS_ASYNC        1
+#define MS_SYNC         2
+#define MS_INVALIDATE   4
+
+#ifndef FILE_MAP_EXECUTE
+#define FILE_MAP_EXECUTE    0x0020
+#endif
+
+static int __map_mman_error(const DWORD err, const int deferr)
+{
+    if (err == 0)
+        return 0;
+    //TODO: implement
+    return err;
+}
+
+static DWORD __map_mmap_prot_page(const int prot)
+{
+    DWORD protect = 0;
+    
+    if (prot == PROT_NONE)
+        return protect;
+        
+    if ((prot & PROT_EXEC) != 0)
+    {
+        protect = ((prot & PROT_WRITE) != 0) ? 
+                    PAGE_EXECUTE_READWRITE : PAGE_EXECUTE_READ;
+    }
+    else
+    {
+        protect = ((prot & PROT_WRITE) != 0) ?
+                    PAGE_READWRITE : PAGE_READONLY;
+    }
+    
+    return protect;
+}
+
+static DWORD __map_mmap_prot_file(const int prot)
+{
+    DWORD desiredAccess = 0;
+    
+    if (prot == PROT_NONE)
+        return desiredAccess;
+        
+    if ((prot & PROT_READ) != 0)
+        desiredAccess |= FILE_MAP_READ;
+    if ((prot & PROT_WRITE) != 0)
+        desiredAccess |= FILE_MAP_WRITE;
+    if ((prot & PROT_EXEC) != 0)
+        desiredAccess |= FILE_MAP_EXECUTE;
+    
+    return desiredAccess;
+}
+
+inline void* mmap(void *addr, size_t len, int prot, int flags, int fildes, off_t off)
+{
+    HANDLE fm, h;
+    
+    void * map = MAP_FAILED;
+    
+#ifdef _MSC_VER
+#pragma warning(push)
+#pragma warning(disable: 4293)
+#endif
+
+    const DWORD dwFileOffsetLow = (sizeof(off_t) <= sizeof(DWORD)) ? 
+                    (DWORD)off : (DWORD)(off & 0xFFFFFFFFL);
+    const DWORD dwFileOffsetHigh = (sizeof(off_t) <= sizeof(DWORD)) ?
+                    (DWORD)0 : (DWORD)((off >> 32) & 0xFFFFFFFFL);
+    const DWORD protect = __map_mmap_prot_page(prot);
+    const DWORD desiredAccess = __map_mmap_prot_file(prot);
+
+    const off_t maxSize = off + (off_t)len;
+
+    const DWORD dwMaxSizeLow = (sizeof(off_t) <= sizeof(DWORD)) ? 
+                    (DWORD)maxSize : (DWORD)(maxSize & 0xFFFFFFFFL);
+    const DWORD dwMaxSizeHigh = (sizeof(off_t) <= sizeof(DWORD)) ?
+                    (DWORD)0 : (DWORD)((maxSize >> 32) & 0xFFFFFFFFL);
+
+#ifdef _MSC_VER
+#pragma warning(pop)
+#endif
+
+    errno = 0;
+    
+    if (len == 0 
+        /* Unsupported flag combinations */
+        || (flags & MAP_FIXED) != 0
+        /* Usupported protection combinations */
+        || prot == PROT_EXEC)
+    {
+        errno = EINVAL;
+        return MAP_FAILED;
+    }
+    
+    h = ((flags & MAP_ANONYMOUS) == 0) ? 
+                    (HANDLE)_get_osfhandle(fildes) : INVALID_HANDLE_VALUE;
+
+    if ((flags & MAP_ANONYMOUS) == 0 && h == INVALID_HANDLE_VALUE)
+    {
+        errno = EBADF;
+        return MAP_FAILED;
+    }
+
+    fm = CreateFileMapping(h, NULL, protect, dwMaxSizeHigh, dwMaxSizeLow, NULL);
+
+    if (fm == NULL)
+    {
+        errno = __map_mman_error(GetLastError(), EPERM);
+        return MAP_FAILED;
+    }
+  
+    map = MapViewOfFile(fm, desiredAccess, dwFileOffsetHigh, dwFileOffsetLow, len);
+
+    CloseHandle(fm);
+  
+    if (map == NULL)
+    {
+        errno = __map_mman_error(GetLastError(), EPERM);
+        return MAP_FAILED;
+    }
+
+    return map;
+}
+
+inline int munmap(void *addr, size_t len)
+{
+    if (UnmapViewOfFile(addr))
+        return 0;
+        
+    errno =  __map_mman_error(GetLastError(), EPERM);
+    
+    return -1;
+}
+
+inline int mprotect(void *addr, size_t len, int prot)
+{
+    DWORD newProtect = __map_mmap_prot_page(prot);
+    DWORD oldProtect = 0;
+    
+    if (VirtualProtect(addr, len, newProtect, &oldProtect))
+        return 0;
+    
+    errno =  __map_mman_error(GetLastError(), EPERM);
+    
+    return -1;
+}
+
+inline int msync(void *addr, size_t len, int flags)
+{
+    if (FlushViewOfFile(addr, len))
+        return 0;
+    
+    errno =  __map_mman_error(GetLastError(), EPERM);
+    
+    return -1;
+}
+
+inline int mlock(const void *addr, size_t len)
+{
+    if (VirtualLock((LPVOID)addr, len))
+        return 0;
+        
+    errno =  __map_mman_error(GetLastError(), EPERM);
+    
+    return -1;
+}
+
+inline int munlock(const void *addr, size_t len)
+{
+    if (VirtualUnlock((LPVOID)addr, len))
+        return 0;
+        
+    errno =  __map_mman_error(GetLastError(), EPERM);
+    
+    return -1;
+}
+
+#if !defined(__MINGW32__)
+inline int ftruncate(const int fd, const int64_t size) {
+    if (fd < 0) {
+        errno = EBADF;
+        return -1;
+    }
+
+    HANDLE h = reinterpret_cast<HANDLE>(_get_osfhandle(fd));
+    LARGE_INTEGER li_start, li_size;
+    li_start.QuadPart = static_cast<int64_t>(0);
+    li_size.QuadPart = size;
+    if (SetFilePointerEx(h, li_start, NULL, FILE_CURRENT) == ~0 ||
+        SetFilePointerEx(h, li_size, NULL, FILE_BEGIN) == ~0 ||
+        !SetEndOfFile(h)) {
+        unsigned long error = GetLastError();
+        fprintf(stderr, "I/O error while truncating: %lu\n", error);
+        switch (error) {
+            case ERROR_INVALID_HANDLE:
+                errno = EBADF;
+                break;
+            default:
+                errno = EIO;
+                break;
+        }
+        return -1;
+    }        
+    return 0;
+}
+#endif
+
+#endif 

data/lib/annoy.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'annoy/version'
-require 'annoy/annoy'
+require 'annoy/annoyext'
 
 module Annoy
   # AnnoyIndex is a class that provides functions for k-nearest neighbors search.
@@ -68,9 +68,10 @@ module Annoy
     # Build a forest of index trees. After building, no more items can be added.
     #
     # @param n_trees [Integer] The number of trees. More trees gives higher search precision.
+    # @param n_jobs [Integer] The number of threads used to build the trees. If -1 is given, uses all available CPU cores.
     # @return [Boolean]
-    def build(n_trees)
-      @index.build(n_trees)
+    def build(n_trees, n_jobs: -1)
+      @index.build(n_trees, n_jobs)
     end
 
     # Save the search index to disk. After saving, no more items can be added.

data/lib/annoy/version.rb

@@ -3,5 +3,5 @@
 # Annoy.rb is a Ruby wrapper for Annoy (Approximate Nearest Neighbors Oh Yeah).
 module Annoy
   # The version of Annoy.rb you are using.
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/sig/annoy.rbs

@@ -0,0 +1,114 @@
+module Annoy
+  VERSION: String
+
+  class AnnoyIndex
+    attr_reader n_features: Integer
+    attr_reader metric: String
+
+    def initialize: (n_features: Integer n_features, ?metric: String metric) -> void
+    def add_item: (Integer i, Array[Float | Integer] v) -> bool
+    def build: (Integer n_trees, ?n_jobs: Integer n_jobs) -> bool
+    def save: (String filename, ?prefault: bool prefault) -> bool
+    def load: (String filename, ?prefault: bool prefault) -> bool
+    def unload: () -> bool
+    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])
+    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])
+    def get_item: (Integer i) -> Array[Float | Integer]
+    def get_distance: (Integer i, Integer j) -> (Float | Integer)
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexAngular
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexDotProduct
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexHamming
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Integer] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Integer]] | Array[Integer])
+    def get_nns_by_vector: (Array[Integer] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Integer]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Integer]
+    def get_distance: (Integer i, Integer j) -> Integer
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexEuclidean
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+
+  class AnnoyIndexManhattan
+    def initialize: (Integer n_features) -> void
+    def add_item: (Integer i, Array[Float] v) -> bool
+    def build: (Integer n_trees, Integer n_jobs) -> bool
+    def save: (String filename, bool prefault) -> bool
+    def load: (String filename, bool prefault) -> bool
+    def unload: () -> bool
+    def get_nns_by_item: (Integer i, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_nns_by_vector: (Array[Float] v, Integer n, Integer search_k, (true | false) include_distances) -> ([Array[Integer], Array[Float]] | Array[Integer])
+    def get_item: (Integer i) -> Array[Float]
+    def get_distance: (Integer i, Integer j) -> Float
+    def n_items: () -> Integer
+    def n_trees: () -> Integer
+    def on_disk_build: (String filename) -> bool
+    def verbose: (bool flag) -> nil
+    def seed: (Integer s) -> nil
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annoy-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - yoshoku
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-08 00:00:00.000000000 Z
+date: 2021-05-23 00:00:00.000000000 Z
 dependencies: []
 description: Annoy.rb is a Ruby binding for the Annoy (Approximate Nearest Neighbors
   Oh Yeah).
@@ -19,31 +19,35 @@ extensions:
 - ext/annoy/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - annoy-rb.gemspec
-- ext/annoy/annoy.cpp
-- ext/annoy/annoy.hpp
+- ext/annoy/annoyext.cpp
+- ext/annoy/annoyext.hpp
 - ext/annoy/extconf.rb
 - ext/annoy/src/annoylib.h
 - ext/annoy/src/kissrandom.h
+- ext/annoy/src/mman.h
 - lib/annoy.rb
 - lib/annoy/version.rb
+- sig/annoy.rbs
 homepage: https://github.com/yoshoku/annoy.rb
 licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/yoshoku/annoy.rb
   source_code_uri: https://github.com/yoshoku/annoy.rb
-  changelog_uri: https://github.com/yoshoku/annoy.rb/blob/master/CHANGELOG.md
-post_install_message:
+  changelog_uri: https://github.com/yoshoku/annoy.rb/blob/main/CHANGELOG.md
+  documentation_uri: https://yoshoku.github.io/annoy.rb/doc/
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -58,8 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Ruby binding for the Annoy (Approximate Nearest Neighbors Oh Yeah).
 test_files: []