umappp 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 652d8cf10c9054b45a567638d8f04f42f8915944bc980c6e28b9e71f0a0f76af
-  data.tar.gz: 2d9f36babd30db2554e6e02753d16d777dabcb2c163f1558f369035317fd1398
+  metadata.gz: cc70f43249cb1993d3fdb810a0cc542e9da383c113f3119414c43723e613ccf0
+  data.tar.gz: ec95857557261b5d1aa066dae830ffb7648e7758dd50a96c14af5332a2563e9f
 SHA512:
-  metadata.gz: 45fe9afc8e8a0917429901ee7cfca09596a4ec6d3e292717aa2035f0ba992e570da604bd22879abfc924ff75e200e2d37513ed82ab7b8d547df9234d025a8429
-  data.tar.gz: 267b65e8883f039e1876a4b4b629cd77b506212641d602bf97f1787103b99457148618188dd6aafdb5c8d96df1e22fa2a2dc0d73a052d4375c6b731288532784
+  metadata.gz: b0d0be70caca251226572ae920adab0938451383a90444235ffd939ad23e58c73034cdce95fa4639d26da9f5517453f0aa2b78fcb8d254d03685726b55ceb10d
+  data.tar.gz: 4cebd1fb124c6d61bf083af58283f75a9e6a714c2ad4425a2c72871fa1bee579bb7377859691187ecfb6f845d6e2b8d4bb670e1837813fe7e6dbb33975aa2c70

data/README.md

@@ -28,10 +28,12 @@ gem install umappp
 This Gem provides the module `Umappp` and its singular method `Umappp.run()`. The first argument of `Umappp.run()` is a two-dimensional Ruby array or a two-dimensional Numo array. [Numo](https://github.com/ruby-numo/numo-narray) is a library for performing N-dimensional array computing like NumPy. The argument is converted to `Numo::SFloat`. SFloat is a single precision floating point number type of Numo::NArray.
 
 ```ruby
-Umappp.run(embedding) # embedding is two-dimensional Ruby array or Numo array
+# The embedding is two-dimensional Ruby array or Numo array
+# Returns Numo::SFloat
+r = Umappp.run(embedding)
 
-# with parameters
-Umappp.run(pixels, num_threads: 8, a: 1.8956, b: 0.8006)
+# Run with parameters
+r = Umappp.run(pixels, num_threads: 8, a: 1.8956, b: 0.8006)
 ```
 
 Available parameters and their default values

data/lib/umappp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Umappp
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/umappp.rb

@@ -6,7 +6,6 @@ require_relative "umappp/umappp"
 
 # Uniform Manifold Approximation and Projection
 module Umappp
-
   # Make wrapper methods for the C++ function generated by Rice private
   private_class_method :umappp_run
   private_class_method :umappp_default_parameters
@@ -17,9 +16,9 @@ module Umappp
     umappp_default_parameters
   end
 
-  # Runs the Uniform Manifold Approximation and Projection (UMAP) dimensional 
-  # reduction technique. 
-  # @param embedding [Array, Numo::SFloat] 
+  # Runs the Uniform Manifold Approximation and Projection (UMAP) dimensional
+  # reduction technique.
+  # @param embedding [Array, Numo::SFloat]
   # @param method [Symbol]
   # @param ndim [Integer]
   # @param tick [Integer]
@@ -38,6 +37,7 @@ module Umappp
   # @param seed [Integer]
   # @param batch [Boolean]
   # @param num_threads [Integer]
+  # @return [Numo::SFloat] the final embedding
 
   def self.run(embedding, method: :annoy, ndim: 2, tick: 0, **params)
     unless (u = (params.keys - default_parameters.keys)).empty?
@@ -45,8 +45,11 @@ module Umappp
     end
 
     nnmethod = %i[annoy vptree].index(method.to_sym)
-    data     = Numo::SFloat.cast(embedding)
+    raise ArgumentError, "method must be :annoy or :vptree" if nnmethod.nil?
+
+    embedding2 = Numo::SFloat.cast(embedding)
+    raise ArgumentError, "embedding must be a 2D array" if embedding2.ndim <= 1
 
-    umappp_run(params, data, ndim, nnmethod, tick)
+    umappp_run(params, embedding2, ndim, nnmethod, tick)
   end
 end

data/vendor/umappp/NeighborList.hpp

@@ -1,6 +1,9 @@
 #ifndef UMAPPP_NEIGHBOR_LIST_HPP
 #define UMAPPP_NEIGHBOR_LIST_HPP
 
+#include <utility>
+#include <vector>
+
 /**
  * @file NeighborList.hpp
  *

data/vendor/umappp/Umap.hpp

@@ -38,7 +38,7 @@ enum InitMethod { SPECTRAL, SPECTRAL_ONLY, RANDOM, NONE };
 /**
  * @cond
  */
-int choose_num_epochs(int num_epochs, size_t size) {
+inline int choose_num_epochs(int num_epochs, size_t size) {
     if (num_epochs < 0) {
         // Choosing the number of epochs. We use a simple formula to decrease
         // the number of epochs with increasing size, with the aim being that

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: umappp
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-10 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray