numo-tiny_linalg 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a298eaec7ee7338e4856ac50b22a06bf774073456a01f5ffb2a405cab632f7a
-  data.tar.gz: a44ae42f723ee7c9a1af6c2b1a01e6257f1fc417a5cd2a22cb6be51ac0589c1c
+  metadata.gz: 81e69278b32b0f565e3f5b5e1eae1738a57556773e9306bb3b0c8450c9fb75ea
+  data.tar.gz: de6daa349cd0d16b14f9c133ad451fac8bacbcd42cca682be68509bd5d8fc416
 SHA512:
-  metadata.gz: fce33aa331257bc37d7a972e09a0cf1d9328046459c9de6b9feaf8341d0d4545d202b90d6bb0e5e6ee097b4c9c58a4bc76fc0224fd87dc10818c8f566259ab7e
-  data.tar.gz: 6da516469d0fdfb47884fea2d9fc2483b5ea066063ce1681afc8e9319d1cfcc6863f59e96a4ce1d7cb22ceb159a8b2f8f6e41478958ea245a5eaaf209753ea2c
+  metadata.gz: 72894605f074e09f47a37834ba1c2b3a3e504e149742df3290fd4c4e8042b1ac0c70d11bd50e4ab83e19b07181d8a656ab57afcaa47de53794fc28a298e1e768
+  data.tar.gz: c896b561fcbeb0ff19196548a3a0f2f6a06098d706fbfe95b785ffd850b139e87ea5d62c1144cde4c456a7ef5bb2b79422b5c2e0ab909df76f5ea9fa4a4bd446

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [[0.1.1](https://github.com/yoshoku/numo-tiny_linalg/compare/v0.1.0...v0.1.1)] - 2023-08-07
+- Fix method of getting start and end of eigenvalue range from vals_range arguement of TinyLinalg.eigh.
+
 ## [[0.1.0](https://github.com/yoshoku/numo-tiny_linalg/compare/v0.0.4...v0.1.0)] - 2023-08-06
 - Refactor codes and update documentations.
 

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.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/numo/tiny_linalg.rb

@@ -39,15 +39,15 @@ module Numo
     #   pp (x - vecs.dot(vals.diag).dot(vecs.transpose)).abs.max
     #   # => 3.3306690738754696e-16
     #
-    # @param a [Numo::NArray] n-by-n symmetric / Hermitian matrix.
-    # @param b [Numo::NArray] n-by-n symmetric / Hermitian matrix. If nil, identity matrix is assumed.
+    # @param a [Numo::NArray] The n-by-n symmetric / Hermitian matrix.
+    # @param b [Numo::NArray] The n-by-n symmetric / Hermitian matrix. If nil, identity matrix is assumed.
     # @param vals_only [Boolean] The flag indicating whether to return only eigenvalues.
     # @param vals_range [Range/Array]
     #   The range of indices of the eigenvalues (in ascending order) and corresponding eigenvectors to be returned.
     #   If nil, all eigenvalues and eigenvectors are computed.
     # @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, Numo::NArray>] The eigenvalues and eigenvectors.
+    # @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
       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]
@@ -70,8 +70,8 @@ module Numo
         vecs, _b, vals, _info = Numo::TinyLinalg::Lapack.send(sy_he_gv.to_sym, a.dup, b.dup, jobz: jobz)
       else
         sy_he_gv << 'x'
-        il = vals_range.first + 1
-        iu = vals_range.last + 1
+        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
         )
@@ -91,7 +91,7 @@ module Numo
     #   pp (3.0 - Numo::Linalg.det(a)).abs
     #   # => 1.3322676295501878e-15
     #
-    # @param a [Numo::NArray] n-by-n square matrix.
+    # @param a [Numo::NArray] The n-by-n square matrix.
     # @return [Float/Complex] The determinant of `a`.
     def det(a)
       raise ArgumentError, 'input array a must be 2-dimensional' if a.ndim != 2
@@ -132,7 +132,7 @@ module Numo
     #   pp inv_a.dot(a).sum
     #   # => 5.0
     #
-    # @param a [Numo::NArray] n-by-n square matrix.
+    # @param a [Numo::NArray] The n-by-n square matrix.
     # @param driver [String] This argument is for compatibility with Numo::Linalg.solver, and is not used.
     # @param uplo [String] This argument is for compatibility with Numo::Linalg.solver, and is not used.
     # @return [Numo::NArray] The inverse matrix of `a`.
@@ -156,7 +156,7 @@ module Numo
       end
     end
 
-    # Compute the (Moore-Penrose) pseudo-inverse of a matrix using singular value decomposition.
+    # Computes the (Moore-Penrose) pseudo-inverse of a matrix using singular value decomposition.
     #
     # @example
     #   require 'numo/tiny_linalg'
@@ -174,7 +174,7 @@ module Numo
     #   # => 3.0
     #
     # @param a [Numo::NArray] The m-by-n matrix to be pseudo-inverted.
-    # @param driver [String] LAPACK driver to be used ('svd' or 'sdd').
+    # @param driver [String] The LAPACK driver to be used ('svd' or 'sdd').
     # @param rcond [Float] The threshold value for small singular values of `a`, default value is `a.shape.max * EPS`.
     # @return [Numo::NArray] The pseudo-inverse of `a`.
     def pinv(a, driver: 'svd', rcond: nil)
@@ -186,7 +186,7 @@ module Numo
       u.dot(vh[0...rank, true]).conj.transpose
     end
 
-    # Compute QR decomposition of a matrix.
+    # Computes the QR decomposition of a matrix.
     #
     # @example
     #   require 'numo/tiny_linalg'
@@ -222,9 +222,8 @@ module Numo
     #   - "r"        -- returns only R,
     #   - "economic" -- returns both Q [m, n] and R [n, n],
     #   - "raw"      -- returns QR and TAU (LAPACK geqrf results).
-    # @return [Numo::NArray] if mode='r'
-    # @return [Array<Numo::NArray,Numo::NArray>] if mode='reduce' or mode='economic'
-    # @return [Array<Numo::NArray,Numo::NArray>] if mode='raw' (LAPACK geqrf result)
+    # @return [Numo::NArray] if mode='r'.
+    # @return [Array<Numo::NArray>] if mode='reduce' or 'economic' or 'raw'.
     def qr(a, mode: 'reduce')
       raise ArgumentError, 'input array a must be 2-dimensional' if a.ndim != 2
       raise ArgumentError, "invalid mode: #{mode}" unless %w[reduce r economic raw].include?(mode)
@@ -295,7 +294,7 @@ module Numo
       Numo::TinyLinalg::Lapack.send(gesv, a.dup, b.dup)[1]
     end
 
-    # Calculates the Singular Value Decomposition (SVD) of a matrix: `A = U * S * V^T`
+    # Computes the Singular Value Decomposition (SVD) of a matrix: `A = U * S * V^T`
     #
     # @example
     #   require 'numo/tiny_linalg'
@@ -328,9 +327,9 @@ module Numo
     #   # => 4.440892098500626e-16
     #
     # @param a [Numo::NArray] Matrix to be decomposed.
-    # @param driver [String] LAPACK driver to be used ('svd' or 'sdd').
-    # @param job [String] Job option ('A', 'S', or 'N').
-    # @return [Array<Numo::NArray>] Singular values and singular vectors ([s, u, vt]).
+    # @param driver [String] The LAPACK driver to be used ('svd' or 'sdd').
+    # @param job [String] The job option ('A', 'S', or 'N').
+    # @return [Array<Numo::NArray>] The singular values and singular vectors ([s, u, vt]).
     def svd(a, driver: 'svd', job: 'A')
       raise ArgumentError, "invalid job: #{job}" unless /^[ASN]/i.match?(job.to_s)
 

metadata

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