numo-tiny_linalg 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aeb68c259f8d4c4dcd44c15caef6926cbe3f26f9dd99e9229721d02a939d7c1
-  data.tar.gz: 5465aebebc07612812b861932fcabf14b66ee0ec389603c9ffcf06694eb69ce4
+  metadata.gz: 911223ba40879d779bcc9bc77b840fb7b5e41ed68d6ccf7d26816913c42aed73
+  data.tar.gz: 9dce9c353da5466e1104c604c2749369131cb6640e14ddd33c697cee5d973563
 SHA512:
-  metadata.gz: 3e1ddd9a4f43d89635d0fc4e07fc3eab0e302b108648e00506deaec106f147f10132b6c28818f6ef054d5fa0ef52bb2c33287dcdeb413fc12268fb35edfde859
-  data.tar.gz: 78903f772d37936f73a69624b3241d43703632f08542a2f57e38a619b6dc1ac012d8885c79056459ef4fd50102d416f996ea54269b64b919ac91a3db46330d8c
+  metadata.gz: 9d666bdd04f48132005a9aee455047c80d83184815fac5c688ec593412ff8e670f1f31ba3376b1ee2985b8e829680590c1dad6a0ec3bf5366e584a82b523d8e4
+  data.tar.gz: 22027c54b56bad7214060ba7d5939b986be660a75afd65d74de7fdae095a6699ceea35422eee56831b621f2132e5bce921cb6b70bc9709e77e3efdf6cfc8a098

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [[0.2.0](https://github.com/yoshoku/numo-tiny_linalg/compare/v0.1.2...v0.2.0)] - 2023-08-11
+**Breaking change**
+- Change LAPACK function to call when array b is not given to TinyLinalg.eigh method.
+
 ## [[0.1.2](https://github.com/yoshoku/numo-tiny_linalg/compare/v0.1.1...v0.1.2)] - 2023-08-09
 - Add dsyev, ssyev, zheev, and cheev module functions to TinyLinalg::Lapack.
 - Add dsyevd, ssyevd, zheevd, and cheevd module functions to TinyLinalg::Lapack.

data/README.md

@@ -8,6 +8,8 @@
 Numo::TinyLinalg is a subset library from [Numo::Linalg](https://github.com/ruby-numo/numo-linalg) consisting only of methods used in Machine Learning algorithms.
 The functions Numo::TinyLinalg supports are dot, det, eigh, inv, pinv, qr, solve, and svd.
 
+Note that the version numbering rule of Numo::TinyLinalg is not compatible with that of Numo::Linalg.
+
 ## Installation
 Unlike Numo::Linalg, Numo::TinyLinalg only supports OpenBLAS as a backend library for BLAS and LAPACK.
 

data/ext/numo/tiny_linalg/lapack/heevr.hpp

@@ -93,7 +93,25 @@ private:
       return Qnil;
     }
 
+    if (range == 'V' && vu <= vl) {
+      rb_raise(rb_eArgError, "vu must be greater than vl");
+      return Qnil;
+    }
+
     const size_t n = NA_SHAPE(a_nary)[1];
+    if (range == 'I' && (il < 1 || il > n)) {
+      rb_raise(rb_eArgError, "il must satisfy 1 <= il <= n");
+      return Qnil;
+    }
+    if (range == 'I' && (iu < 1 || iu > n)) {
+      rb_raise(rb_eArgError, "iu must satisfy 1 <= iu <= n");
+      return Qnil;
+    }
+    if (range == 'I' && iu < il) {
+      rb_raise(rb_eArgError, "iu must be greater than or equal to il");
+      return Qnil;
+    }
+
     size_t m = range != 'I' ? n : iu - il + 1;
     size_t w_shape[1] = { m };
     size_t z_shape[2] = { n, m };

data/ext/numo/tiny_linalg/lapack/hegvx.hpp

@@ -114,7 +114,25 @@ private:
       return Qnil;
     }
 
+    if (range == 'V' && vu <= vl) {
+      rb_raise(rb_eArgError, "vu must be greater than vl");
+      return Qnil;
+    }
+
     const size_t n = NA_SHAPE(a_nary)[1];
+    if (range == 'I' && (il < 1 || il > n)) {
+      rb_raise(rb_eArgError, "il must satisfy 1 <= il <= n");
+      return Qnil;
+    }
+    if (range == 'I' && (iu < 1 || iu > n)) {
+      rb_raise(rb_eArgError, "iu must satisfy 1 <= iu <= n");
+      return Qnil;
+    }
+    if (range == 'I' && iu < il) {
+      rb_raise(rb_eArgError, "il must be less than or equal to iu");
+      return Qnil;
+    }
+
     size_t m = range != 'I' ? n : iu - il + 1;
     size_t w_shape[1] = { m };
     size_t z_shape[2] = { n, m };

data/ext/numo/tiny_linalg/lapack/syevr.hpp

@@ -90,7 +90,25 @@ private:
       return Qnil;
     }
 
+    if (range == 'V' && vu <= vl) {
+      rb_raise(rb_eArgError, "vu must be greater than vl");
+      return Qnil;
+    }
+
     const size_t n = NA_SHAPE(a_nary)[1];
+    if (range == 'I' && (il < 1 || il > n)) {
+      rb_raise(rb_eArgError, "il must satisfy 1 <= il <= n");
+      return Qnil;
+    }
+    if (range == 'I' && (iu < 1 || iu > n)) {
+      rb_raise(rb_eArgError, "iu must satisfy 1 <= iu <= n");
+      return Qnil;
+    }
+    if (range == 'I' && iu < il) {
+      rb_raise(rb_eArgError, "iu must be greater than or equal to il");
+      return Qnil;
+    }
+
     size_t m = range != 'I' ? n : iu - il + 1;
     size_t w_shape[1] = { m };
     size_t z_shape[2] = { n, m };

data/ext/numo/tiny_linalg/lapack/sygvx.hpp

@@ -113,7 +113,25 @@ private:
       return Qnil;
     }
 
+    if (range == 'V' && vu <= vl) {
+      rb_raise(rb_eArgError, "vu must be greater than vl");
+      return Qnil;
+    }
+
     const size_t n = NA_SHAPE(a_nary)[1];
+    if (range == 'I' && (il < 1 || il > n)) {
+      rb_raise(rb_eArgError, "il must satisfy 1 <= il <= n");
+      return Qnil;
+    }
+    if (range == 'I' && (iu < 1 || iu > n)) {
+      rb_raise(rb_eArgError, "iu must satisfy 1 <= iu <= n");
+      return Qnil;
+    }
+    if (range == 'I' && iu < il) {
+      rb_raise(rb_eArgError, "iu must be greater than or equal to il");
+      return Qnil;
+    }
+
     size_t m = range != 'I' ? n : iu - il + 1;
     size_t w_shape[1] = { m };
     size_t z_shape[2] = { n, m };

data/lib/numo/tiny_linalg/version.rb

@@ -5,6 +5,6 @@ module Numo
   # Numo::TinyLinalg is a subset library from Numo::Linalg consisting only of methods used in Machine Learning algorithms.
   module TinyLinalg
     # The version of Numo::TinyLinalg you install.
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

data/lib/numo/tiny_linalg.rb

@@ -48,35 +48,50 @@ module Numo
     # @param uplo [String] This argument is for compatibility with Numo::Linalg.solver, and is not used.
     # @param turbo [Bool] The flag indicating whether to use a divide and conquer algorithm. If vals_range is given, this flag is ignored.
     # @return [Array<Numo::NArray>] The eigenvalues and eigenvectors.
-    def eigh(a, b = nil, vals_only: false, vals_range: nil, uplo: 'U', turbo: false) # rubocop:disable Metrics/AbcSize, Metrics/ParameterLists, Lint/UnusedMethodArgument
+    def eigh(a, b = nil, vals_only: false, vals_range: nil, uplo: 'U', turbo: false) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/ParameterLists, Metrics/PerceivedComplexity, Lint/UnusedMethodArgument
       raise ArgumentError, 'input array a must be 2-dimensional' if a.ndim != 2
       raise ArgumentError, 'input array a must be square' if a.shape[0] != a.shape[1]
 
+      b_given = !b.nil?
+      raise ArgumentError, 'input array b must be 2-dimensional' if b_given && b.ndim != 2
+      raise ArgumentError, 'input array b must be square' if b_given && b.shape[0] != b.shape[1]
+      raise ArgumentError, "invalid array type: #{b.class}" if b_given && blas_char(b) == 'n'
+
       bchr = blas_char(a)
       raise ArgumentError, "invalid array type: #{a.class}" if bchr == 'n'
 
-      unless b.nil?
-        raise ArgumentError, 'input array b must be 2-dimensional' if b.ndim != 2
-        raise ArgumentError, 'input array b must be square' if b.shape[0] != b.shape[1]
-        raise ArgumentError, "invalid array type: #{b.class}" if blas_char(b) == 'n'
-      end
-
       jobz = vals_only ? 'N' : 'V'
-      b = a.class.eye(a.shape[0]) if b.nil?
-      sy_he_gv = %w[d s].include?(bchr) ? "#{bchr}sygv" : "#{bchr}hegv"
 
-      if vals_range.nil?
-        sy_he_gv << 'd' if turbo
-        vecs, _b, vals, _info = Numo::TinyLinalg::Lapack.send(sy_he_gv.to_sym, a.dup, b.dup, jobz: jobz)
+      if b_given
+        fnc = %w[d s].include?(bchr) ? "#{bchr}sygv" : "#{bchr}hegv"
+        if vals_range.nil?
+          fnc << 'd' if turbo
+          vecs, _b, vals, _info = Numo::TinyLinalg::Lapack.send(fnc.to_sym, a.dup, b.dup, jobz: jobz)
+        else
+          fnc << 'x'
+          il = vals_range.first(1)[0] + 1
+          iu = vals_range.last(1)[0] + 1
+          _a, _b, _m, vals, vecs, _ifail, _info = Numo::TinyLinalg::Lapack.send(
+            fnc.to_sym, a.dup, b.dup, jobz: jobz, range: 'I', il: il, iu: iu
+          )
+        end
       else
-        sy_he_gv << 'x'
-        il = vals_range.first(1)[0] + 1
-        iu = vals_range.last(1)[0] + 1
-        _a, _b, _m, vals, vecs, _ifail, _info = Numo::TinyLinalg::Lapack.send(
-          sy_he_gv.to_sym, a.dup, b.dup, jobz: jobz, range: 'I', il: il, iu: iu
-        )
+        fnc = %w[d s].include?(bchr) ? "#{bchr}syev" : "#{bchr}heev"
+        if vals_range.nil?
+          fnc << 'd' if turbo
+          vecs, vals, _info = Numo::TinyLinalg::Lapack.send(fnc.to_sym, a.dup, jobz: jobz)
+        else
+          fnc << 'r'
+          il = vals_range.first(1)[0] + 1
+          iu = vals_range.last(1)[0] + 1
+          _a, _m, vals, vecs, _isuppz, _info = Numo::TinyLinalg::Lapack.send(
+            fnc.to_sym, a.dup, jobz: jobz, range: 'I', il: il, iu: iu
+          )
+        end
       end
+
       vecs = nil if vals_only
+
       [vals, vecs]
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-tiny_linalg
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - yoshoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray