ac-library-rb 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a727abb00ad78ee815885a24058313b8d5d2d74dca890a7f86acec05a1409c29
-  data.tar.gz: 2cf27a5f5c961d3c66c42327820046ee282d461bab07fcc5d3137c1ef070667c
+  metadata.gz: 4f2e1122b67c3de38764556c098f3baca940daf337deae414b37ca57c0d23066
+  data.tar.gz: a5623bda479b49cd40885aa202b64c3075b292db06c3f0b2fea6ba2882e8e281
 SHA512:
-  metadata.gz: 409b1168b103fcfb0addb14166550ea6558481e19cd614996952b0059f488a2244dfec992686039e8b84e573c24639a0722dcf1898988335b52896645b524af5
-  data.tar.gz: 9ada51ba77c9101ca49a91a086b9204407ca526621e7a5621e797a16f1399e330aeb7ef9fdbb1ae2b8b5a1825f2bc06c6b82efe9367a961e97531d899ab6b6fe
+  metadata.gz: 5f38c20da10aa7b69cc140b8c79e7f3152271b77fe265f6ad8b93114a986b714b7b004cec5365477d6661192ed319da126868e8151ac00236633a5e5c6ac22a6
+  data.tar.gz: ed0b8ff7db0eff11fdf751acba9b111488d14babb845c747fb7856888d600b34e5f53208b6aa2fdbddb9ad1001996040dafb6a240498d59a5517fd6d8dfa0229

data/.rubocop.yml

@@ -100,6 +100,9 @@ Naming/MethodName:
     - 'test/convolution_test.rb'
 Naming/MethodParameterName:
   Enabled: false
+Naming/VariableNumber:
+  Exclude:
+    - 'test/max_flow_test.rb'
 Style/AndOr:
   Enabled: false
 Style/ArrayCoercion:

data/README.ja.md

@@ -15,13 +15,88 @@ ACLの詳細は、以下をご覧ください.
 
 [ライブラリ目次: index.md](https://github.com/universato/ac-library-rb/blob/master/document_ja/index.md)
 
-`lib`ディレクトリにコードがあります。
+公式に、ac-library-rbの利用として、以下の方法を想定しています。
+- 直接コピペして使う方法
+  - `lib`ディレクトリに、ac-library-rbのライブラリのコードがあります。
+  - `lib_lock`ディレクトリに、Gem用にモジュール化されたコードがあります。
+    (別途モジュール化するの、ちょっとトリッキーですが……)
+- Gemとして使う方法(詳細は後述)
 
-現状、この中から探してもらい、コピペして使って下さい。
+他に、有志作成のバンドルツール[expander-rb](https://github.com/surpace/expander-rb)(by surpaceさん)を利用する方法もあります。
 
-目次(および進捗情報)は、[index.md](https://github.com/universato/ac-library-rb/blob/master/document_ja/index.md)をご覧ください。
+目次は、[index.md](https://github.com/universato/ac-library-rb/blob/master/document_ja/index.md)をご覧ください。
 
-また、コピペ以外の方法として、バンドルツール[expander-rb](https://github.com/surpace/expander-rb)(by surpaceさん)を利用する方法もあります。
+## Gemとなったac-library-rbを使う方法
+
+コピペ以外にGemとなったac-library-rbを使う方法を紹介します。
+
+### gemのインストール方法
+
+ac-library-rbに限った話ではないですが、一般的な2種類のgemのインストール方法を紹介します。
+
+- Gemとして使う方法
+  - `gem`コマンドにより、`gem install ac-library-rb`
+  - gemのbundlerを用いる方法
+
+#### gemコマンドによるインストール方法
+
+Ruby本体に付属のgemコマンドを用い、そのまま`gem install ac-library-rb`を実行します。
+
+#### gemのbundlerを用いたインストール方法
+
+bundlerをインストールしてない場合は、`gem install bundler`というコマンドを打ちインストールします。
+
+次に、ac-library-rbを使いたいディレクトリ配下にGemfileを置きます。Gemfileという名称のファイルです。  
+このGemfileの中で、次のように書きます。
+```
+gem "ac-library-rb"
+```
+そして、`budnle install`というコマンドにより、Gemfileに書かれたac-library-rbをインストールします。
+
+このとき、bundlerを通してRubyファイルを実行する必要があるため、`bundle exec`コマンドを用います。
+
+`$ bundle exec ruby sample.rb`
+
+### (インストール後の)Rubyファイルでの書き方
+
+#### 一括ロード
+
+Rubyファイル上で一括でac-library-rbのライブラリを使えるようにするには、下記のように書きます。
+
+```ruby
+require "ac-library-rb/all"
+
+dsu = AcLibraryRb::DSU.new
+
+include AcLibraryRb
+dsu = DSU.new
+```
+
+`include AcLibraryRb`とモジュールをインクルードすることで、  
+何度も`AcLibraryRb`といわゆる名前空間を書く必要がなくなります。
+
+また、`/all`なしで`require "ac-library-rb"`とした場合は、`include AcLibraryRb`も同時に実行されます。
+```ruby
+require "ac-library-rb"
+
+dsu = DSU.new
+```
+
+#### 個別ロード
+
+特定のライブラリのみをインストールしたいときは下記のように`ac-library-rb/`のあとにライブラリ名を指定します。
+
+```ruby
+require "ac-library-rb/dsu"
+dsu = AcLibraryRb::DSU.new
+
+require "ac-library-rb/priority_queue"
+pq = AcLibraryRb::PriorityQueue.new
+```
+
+本gem名はハイフン区切りですが、ac-library-rb内のライブラリ名はアンダースコア区切りであるため、注意して下さい。  
+一般的にRubyのライブラリ名はアンダースコアが推奨されていますが、  
+ACL本家のレポジトリ名がac-libraryとハイフン区切りで、それに合わせているため、レポジトリ名・gem名がハイフン区切りとなっています。
 
 ## Rubyバージョン
 

data/README.md

@@ -25,6 +25,69 @@ Therefore, 2.7.1 is recommended and may not work with other versions.
 
 Please read [index.md](https://github.com/universato/ac-library-rb/blob/master/document_en/index.md).
 
+## How to use ac-library-rb as a Gem
+
+We will show you how to use ac-library-rb as a gem.
+## How to install
+
+This is not limited to ac-library-rb, but I will show you how to install the two common types of gem.
+
+- By `gem` command, `gem install ac-library-rb`.
+- By using the gem bundler's commands.
+
+By #### gem command, `gem install ac-library-rb`
+
+Execute `gem install ac-library-rb` by using the gem command included in Ruby itself.
+
+#### How to use the gem bundler
+
+If you have not installed bundler, type `gem install bundler` to install it.
+
+Next, place Gemfile under the directory where you want to use ac-library-rb.  
+
+In this Gemfile, write: 
+
+```ruby
+gem "ac-library-rb".
+```
+
+Then, install ac-library-rb by using the command `budnle install`.
+
+At this point, we need to run the Ruby file through bundler, so we use the command `bundle exec`.
+
+`$ bundle exec ruby sample.rb`.
+
+### How to write in Ruby files (after installation)
+
+#### Bulk loading
+
+To enable the ac-library-rb library to be used in bulk on Ruby files, write as follows.
+
+```ruby
+require "ac-library-rb/all"
+
+dsu = AcLibraryRb::DSU.new
+
+include AcLibraryRb
+dsu = DSU.new
+```
+
+#### Individual loading
+
+If you want to install only a specific library, specify the library name after `ac-library-rb/` as shown below.
+
+```ruby
+require "ac-library-rb/dsu"
+dsu = AcLibraryRb::DSU.new
+
+require "ac-library-rb/priority_queue"
+pq = AcLibraryRb::PriorityQueue.new
+```
+
+Note that the gem names are separated by hyphens, but the library names in ac-library-rb are separated by underscores. 
+In general, underscores are recommended for Ruby library names.
+However, the repository names in the original ACL are separated by a hyphen, ac-library, so ac-library-rb is also separated by a hyphen.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -2,7 +2,8 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  require_relative "./bin/lock_lib.rb"
+  # require_relative "./bin/lock_lib.rb"
+  t.warning = false
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]

data/ac-library-rb.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.description   = gem_description
   spec.homepage      = "https://github.com/universato/ac-library-rb"
   spec.license       = "CC0"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/universato/ac-library-rb"
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"

data/bin/lock_lib.rb

@@ -1,22 +1,24 @@
 require 'pathname'
 
 # copy libraries from `lib` to `lib_lock/ac-library` and add `module AcLibraryRb`
-lib_path = File.expand_path('../../lib/**', __FILE__)
-lock_dir = File.expand_path('../../lib_lock/ac-library-rb', __FILE__)
+lib_path = File.expand_path('../lib/**', __dir__)
+lock_dir = File.expand_path('../lib_lock/ac-library-rb', __dir__)
 Dir.glob(lib_path) do |file|
   next unless FileTest.file?(file)
 
   path = Pathname.new(lock_dir) + Pathname.new(file).basename
   File.open(path, "w") do |f|
+    library_code = File.readlines(file).map{ |line| line == "\n" ? "\n" : '  ' + line }
+
     f.puts "module AcLibraryRb"
-    f.puts File.readlines(file).map{ |line| line == "\n" ? "\n" : '  ' + line }
+    f.puts library_code
     f.puts "end"
   end
 end
 
-# cope library from `lib/core_ext` to `lib_lock/ac-library-rb/core_ext`
-lib_path = File.expand_path('../../lib/core_ext/**', __FILE__)
-lock_dir = File.expand_path('../../lib_lock/ac-library-rb/core_ext', __FILE__)
+# copy library from `lib/core_ext` to `lib_lock/ac-library-rb/core_ext`
+lib_path = File.expand_path('../lib/core_ext/**', __dir__)
+lock_dir = File.expand_path('../lib_lock/ac-library-rb/core_ext', __dir__)
 Dir.glob(lib_path) do |file|
   next unless FileTest.file?(file)
 

data/lib/ac-library-rb/version.rb

@@ -1,3 +1,3 @@
 module AcLibraryRb
-  VERSION = "0.5.0".freeze
+  VERSION = "0.5.1".freeze
 end

data/lib/modint.rb

@@ -161,7 +161,9 @@ class ModInt < Numeric
 
   def inv_internal(a)
     if $_mod_is_prime
-      a != 0 ? a.pow($_mod - 2, $_mod) : raise(RangeError, 'no inverse')
+      raise(RangeError, 'no inverse') if a == 0
+
+      a.pow($_mod - 2, $_mod)
     else
       g, x = ModInt.inv_gcd(a, $_mod)
       g == 1 ? x : raise(RangeError, 'no inverse')

data/lib/suffix_array.rb

@@ -76,9 +76,7 @@ def sa_is(s, upper)
     end_l = lms[lms_map[l] + 1] || n
     end_r = lms[lms_map[r] + 1] || n
     same = true
-    if end_l - l != end_r - r
-      same = false
-    else
+    if end_l - l == end_r - r
       while l < end_l
         break if s[l] != s[r]
 
@@ -86,6 +84,8 @@ def sa_is(s, upper)
         r += 1
       end
       same = false if l == n || s[l] != s[r]
+    else
+      same = false
     end
     rec_upper += 1 if not same
     rec_s[lms_map[sorted_lms[i]]] = rec_upper
@@ -100,7 +100,11 @@ end
 
 # suffix array for array of integers or string
 def suffix_array(s, upper = nil)
-  if not upper
+  if upper
+    s.each{ |s|
+      raise ArgumentError if s < 0 || upper < s
+    }
+  else
     case s
     when Array
       # compression
@@ -118,10 +122,6 @@ def suffix_array(s, upper = nil)
       upper = 255
       s = s.bytes
     end
-  else
-    s.each{ |s|
-      raise ArgumentError if s < 0 || upper < s
-    }
   end
 
   return sa_is(s, upper)

data/lib_lock/ac-library-rb/modint.rb

@@ -162,7 +162,9 @@ module AcLibraryRb
 
     def inv_internal(a)
       if $_mod_is_prime
-        a != 0 ? a.pow($_mod - 2, $_mod) : raise(RangeError, 'no inverse')
+        raise(RangeError, 'no inverse') if a == 0
+
+        a.pow($_mod - 2, $_mod)
       else
         g, x = ModInt.inv_gcd(a, $_mod)
         g == 1 ? x : raise(RangeError, 'no inverse')

data/lib_lock/ac-library-rb/suffix_array.rb

@@ -77,9 +77,7 @@ module AcLibraryRb
       end_l = lms[lms_map[l] + 1] || n
       end_r = lms[lms_map[r] + 1] || n
       same = true
-      if end_l - l != end_r - r
-        same = false
-      else
+      if end_l - l == end_r - r
         while l < end_l
           break if s[l] != s[r]
 
@@ -87,6 +85,8 @@ module AcLibraryRb
           r += 1
         end
         same = false if l == n || s[l] != s[r]
+      else
+        same = false
       end
       rec_upper += 1 if not same
       rec_s[lms_map[sorted_lms[i]]] = rec_upper
@@ -101,7 +101,11 @@ module AcLibraryRb
 
   # suffix array for array of integers or string
   def suffix_array(s, upper = nil)
-    if not upper
+    if upper
+      s.each{ |s|
+        raise ArgumentError if s < 0 || upper < s
+      }
+    else
       case s
       when Array
         # compression
@@ -119,10 +123,6 @@ module AcLibraryRb
         upper = 255
         s = s.bytes
       end
-    else
-      s.each{ |s|
-        raise ArgumentError if s < 0 || upper < s
-      }
     end
 
     return sa_is(s, upper)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ac-library-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - universato
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -144,14 +144,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: ac-library-rb is a ruby port of AtCoder Library (ACL).