randsvd 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d2c9e241646eaca8d1efb45ad72b3662b31b9887
-  data.tar.gz: fcb5fc76673874d947fcd7094ceda6ec954fe025
+SHA256:
+  metadata.gz: f6a549a51ab2ed25c96e636f86cc5cc42cb628ce2addb14f42d5e894c406bdd0
+  data.tar.gz: a1e42f0d9017b323b92d9b59468a37d5ce76508ab7de24e661f0dc062ab9b32f
 SHA512:
-  metadata.gz: 1a780bb65d483996b492c8c0123379c9b917c60699c60a51f905a0a64d00d27c2a36ff22b0b933fbb549fbdfdd96657c058c418569b08dcb6a35f232c980e208
-  data.tar.gz: 144eac0afa622d5fa7613e1403f4fdc88125fcbbabbced72775be41b0f6fd44193da8c496c2d09fdc3a6d33b646b2a1f74300d7c2373f36a33b8e850ead538b3
+  metadata.gz: f53887728067b34dca5bd60fda4149902882bc2131e488186b2d16b468cd30f59d3d9ada48810b692858b726284035ebfa6e7737b25b7630242e0e6d34e10f73
+  data.tar.gz: 33114840169f5029d68f0ce7db578f812e8536c680848dbb4d9b0c32e51dbb3d43f2c3bcc8fbf97c393737191ee246fd0811187a4e693b9ec10933e71393f349

data/.github/workflows/build.yml

@@ -0,0 +1,24 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.7' ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install BLAS and LAPACK
+        run: sudo apt-get install -y libopenblas-dev libatlas-base-dev liblapacke-dev
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          gem install --no-document bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# 0.2.0
+- Add type declaration file: sig/randsvd.rbs
+- Add frozen string literal comment.
+- Fix some configuration files.
+
+# 0.1.2
+- Change the visibility of protected methods to private.
+- Add NMatrix gems to runtime dependency.
+
+# 0.1.1
+- Add option for setting random seed to gesvd and gesdd methods.
+
+# 0.1.0
+- First release.

data/Gemfile

@@ -4,3 +4,9 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in randsvd.gemspec
 gemspec
+
+gem "bundler", "~> 2.0"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rbs", "~> 1.2"
+gem "steep", "~> 0.44"

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 yoshoku
+Copyright (c) 2017-2021 yoshoku
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # RandSVD
 
-[![Build Status](https://travis-ci.org/yoshoku/RandSVD.svg?branch=master)](https://travis-ci.org/yoshoku/RandSVD)
+[![Build Status](https://github.com/yoshoku/randsvd/actions/workflows/build.yml/badge.svg)](https://github.com/yoshoku/randsvd/actions/workflows/build.yml)
 [![Gem Version](https://badge.fury.io/rb/randsvd.svg)](https://badge.fury.io/rb/randsvd)
 
 RandSVD is a class that performs truncated singular value decomposition using a randomized algorithm.
@@ -41,15 +41,11 @@ u, s, vt = RandSVD.gesvd(input_matrix, nb_singular_values)
 reconstructed_matrix = u.dot(NMatrix.diag(s).dot(vt))
 ```
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/randsvd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/randsvd.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/Steepfile

@@ -0,0 +1,20 @@
+target :lib do
+  signature "sig"
+
+  check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   library "nmatrix"           # Gems
+end
+
+# target :spec do
+#   signature "sig", "sig-private"
+#
+#   check "spec"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "rspec"
+# end

data/lib/randsvd.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'randsvd/version'
 require 'nmatrix/lapacke'
 

data/lib/randsvd/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class RandSVD
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.2.0'
 end

data/randsvd.gemspec

@@ -21,10 +21,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'nmatrix', '~> 0.2.3'
-  spec.add_runtime_dependency 'nmatrix-lapacke', '~> 0.2.3'
-
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'nmatrix'
+  spec.add_runtime_dependency 'nmatrix-lapacke'
 end

data/sig/patch.rbs

@@ -0,0 +1,20 @@
+class NMatrix
+  INDEX_DTYPE: Symbol
+
+  def self.size: (untyped shape) -> untyped
+
+  def initialize: (*untyped) -> untyped
+
+  def []: (*untyped) -> untyped
+  def *: (untyped) -> untyped
+  def +: (untyped) -> untyped
+
+  def shape: () -> untyped
+  def transpose: (?untyped permute) -> untyped
+  def dot: (untyped right_v) -> untyped
+  def log: (*untyped) -> untyped
+  def sin: () -> untyped
+  def factorize_qr: () -> untyped
+  def gesdd: (?untyped workspace_size) -> untyped
+  def gesvd: (?untyped workspace_size) -> untyped
+end

data/sig/randsvd.rbs

@@ -0,0 +1,16 @@
+class RandSVD
+  VERSION: String
+
+  attr_reader self.seed: untyped
+
+  def self.gesvd: (NMatrix mat, Integer k, ?::Integer t, ?Integer? seed) -> [NMatrix, NMatrix, NMatrix]
+  def self.gesdd: (NMatrix mat, Integer k, ?::Integer t, ?Integer? seed) -> [NMatrix, NMatrix, NMatrix]
+
+  private
+
+  def self.rsvd: (NMatrix mat, Integer k, Integer t, Integer svd_type) -> [NMatrix, NMatrix, NMatrix]
+  def self.rand_uniform: (Array[Integer] shape) -> NMatrix
+  def self.rand_normal: (Array[Integer] shape, ?Float mu, ?Float sigma) -> NMatrix
+  def self.make_orthonormal_mat: (NMatrix mat, Integer l, Integer t) -> NMatrix
+  def self.truncate_svd_mats: (NMatrix mat_u, NMatrix vec_s, NMatrix mat_v, Integer k) -> [NMatrix, NMatrix, NMatrix]
+end

metadata

@@ -1,107 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: randsvd
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - yoshoku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-07 00:00:00.000000000 Z
+date: 2021-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nmatrix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nmatrix-lapacke
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: 
 email:
 - yoshoku@outlook.com
-executables:
-- randsvd
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
-- exe/randsvd
+- Steepfile
 - lib/randsvd.rb
 - lib/randsvd/version.rb
 - randsvd.gemspec
+- sig/patch.rbs
+- sig/randsvd.rbs
 homepage: https://github.com/yoshoku/randsvd
 licenses:
 - MIT
@@ -121,8 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: RandSVD is a class that performs truncated singular value decomposition using

data/.travis.yml

@@ -1,14 +0,0 @@
-sudo: false
-os: linux
-dist: trusty
-language: ruby
-rvm:
-  - 2.2.9
-before_install:
-  - gem install --no-document bundler -v '~> 1.16'
-addons:
-  apt:
-    packages:
-      - liblapack-dev
-      - liblapacke-dev
-

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "randsvd"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/exe/randsvd

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-
-require "randsvd"