ac-library-rb 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a727abb00ad78ee815885a24058313b8d5d2d74dca890a7f86acec05a1409c29
-  data.tar.gz: 2cf27a5f5c961d3c66c42327820046ee282d461bab07fcc5d3137c1ef070667c
+  metadata.gz: f191f90563fea038c7181e2bf9d13e1dc8caa0e816a364176e46b67c8d63f471
+  data.tar.gz: c89db082816046146cb60faa3747e046877394bfff776a3defe8063fb2d1c390
 SHA512:
-  metadata.gz: 409b1168b103fcfb0addb14166550ea6558481e19cd614996952b0059f488a2244dfec992686039e8b84e573c24639a0722dcf1898988335b52896645b524af5
-  data.tar.gz: 9ada51ba77c9101ca49a91a086b9204407ca526621e7a5621e797a16f1399e330aeb7ef9fdbb1ae2b8b5a1825f2bc06c6b82efe9367a961e97531d899ab6b6fe
+  metadata.gz: '0114099d09f9566741d84ed2b5e43427b62592bb8b2a6b90d25b9f68288d2a387f34899351d18a7b3e0c93ec72af9cae4aac2f1d38f5fe517e30ec850e33429e'
+  data.tar.gz: cdb1eac1808855f86c00c991b4c66ae3489035420ef0fdb8c88915712ace8faa5db02da074a78734e0c4235058ac1e2a62a0fc9cc0523e6c85aff4617b47ae39

data/.rubocop.yml

@@ -91,6 +91,7 @@ Naming/FileName:
     - 'lib_lock/ac-library-rb.rb'
 Naming/AccessorMethodName:
   Exclude:
+    - 'lib/lazy_segtree.rb'
     - 'lib/modint.rb'
 Naming/MethodName:
   Exclude:
@@ -100,6 +101,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:
@@ -117,12 +121,19 @@ Style/BlockDelimiters:
     - 'test/z_algorithm_test.rb'
 Style/Documentation:
   Enabled: false
+tyle/EmptyElse:
+  Exclude:
+    - 'test/segtree_test.rb'
 Style/GlobalVars:
   AutoCorrect: false
   Exclude:
     - 'lib/modint.rb'
+    - 'test/lazy_segtree_test.rb'
 Style/FrozenStringLiteralComment:
   Enabled: false
+Style/InfiniteLoop:
+  Exclude:
+    - 'lib/floor_sum.rb'
 Style/InverseMethods:
   AutoCorrect: false
   Exclude:
@@ -176,6 +187,7 @@ Style/SelfAssignment:
 Style/Semicolon:
   Exclude:
     - 'lib/lazy_segtree.rb'
+    - 'test/lazy_segtree_test.rb'
 Style/SlicingWithRange:
   Enabled: false
 Style/SpecialGlobalVars:

data/README.ja.md

@@ -1,5 +1,7 @@
 # ac-library-rb
 
+[![Gem Version](https://badge.fury.io/rb/ac-library-rb.svg)](https://badge.fury.io/rb/ac-library-rb)
+
 ac-library-rbは、AtCoder Library (ACL)のRuby版です。
 
 ACLの詳細は、以下をご覧ください.
@@ -15,13 +17,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)をご覧ください。
+
+## 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のライブラリを使えるようにするには、下記のように書きます。
 
-目次(および進捗情報)は、[index.md](https://github.com/universato/ac-library-rb/blob/master/document_ja/index.md)をご覧ください。
+```ruby
+require "ac-library-rb/all"
 
-また、コピペ以外の方法として、バンドルツール[expander-rb](https://github.com/surpace/expander-rb)(by surpaceさん)を利用する方法もあります。
+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バージョン
 
@@ -39,12 +116,33 @@ ACLの詳細は、以下をご覧ください.
 
 宣伝・バグ報告などしてもらえると嬉しいです。
 
+## ac-library-rbを開発したい方向けの情報
+
+### コーディングスタイル
+
+Rubocop(Rubyのlintツール)の設定ファイル`.rubocop.yml`は、参考に置いています。  
+Rubocopのルールを守ることが必ずしもよくなかったり、ルールを守ることが難しかったりもするので、Rubocopの適用は必須ではないです。  
+
+推奨スタイル
+- インデントは、半角スペース2文字
+- 行末の余計なスペースは削除
+
+### ディレクトリの説明
+
+`lib`ディレクトリ内に各種のデータ構造などのライブラリがあります。  
+`lib_lock`は、Gem用にモジュール化させるため`lib`の内容をコピーする形でモジュール化させています。  
+`bin/lock_lib.rb`を実行することで、`lib`から`lib_lock`にモジュール化させる形でコピーします。  
+なお、`rake`コマンドでテストを実行させると、自動的に`require_relative "./bin/lock_lib.rb"`により、コピーが行われます。  
+このあたりはトリッキーで、予定は未定ですが、今後全てモジュール化される等に統一される可能性があります。  
+
 ## その他の情報
 
 ### RubyのSlackのAtCoderチャンネル
 
 [ruby-jp](https://ruby-jp.github.io/) に"atcoder"というチャンネルがあります。
 
+ここで、バグ報告などすると、競プロ詳しい人などが反応しやすいかもしれません。
+
 Slackに3000人、atcoderチャンネルに250人以上の登録者がいるので、お気軽に参加してください。
 
 ### 他言語のライブラリ

data/README.md

@@ -7,6 +7,8 @@
 
 # ac-library-rb
 
+[![Gem Version](https://badge.fury.io/rb/ac-library-rb.svg)](https://badge.fury.io/rb/ac-library-rb)
+
 ac-library-rb is a ruby port of AtCoder Library (ACL).
 
 See below for ACL.
@@ -25,6 +27,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.
@@ -35,7 +100,14 @@ $ rake
 $ ruby test/fenwick_tree_test.rb
 ```
 
-# Other language Japanese version
+# Other
+
+## Other languages's ac-library
+
+- [Unofficial Portings of AtCoder Library](https://docs.google.com/spreadsheets/d/19jMAqUbv98grVkLV_Lt54x5B8ILoTcvBzG8EbSvf5gY/edit#gid=0) (by [not522-san](https://github.com/not522))
+
+
+## Other language Japanese version
 
 [README 日本語バージョン(ver. Japanese)](README.ja.md)
 - [ライブラリ目次: index.md](https://github.com/universato/ac-library-rb/blob/master/document_ja/index.md)

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" # for copy
+  t.warning = false
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]

data/ac-library-rb.gemspec

@@ -13,17 +13,18 @@ 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"
 
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
 
   # 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,27 +1,33 @@
 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`
+ac_library_rb_classes = %w[ModInt FenwickTree PriorityQueue]
+replaces = ac_library_rb_classes.to_h{ |cls| ["#{cls}.new", "AcLibraryRb::#{cls}.new"] }
+pattern = Regexp.new(replaces.keys.join('|'))
+
+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)
 
   path = Pathname.new(lock_dir) + Pathname.new(file).basename
   File.open(path, "w") do |f|
-    f.puts File.readlines(file)
+    f.puts File.readlines(file).map{ |text| text.gsub(pattern, replaces) }
   end
 end

data/document_en/dsu.md

@@ -27,7 +27,7 @@ p d.size(2)     # => 2
 
 ## Class Method
 
-### new(n = 0) -> DSU
+### new(n) -> DSU
 
 ```rb
 d = DSU.new(n)
@@ -41,7 +41,7 @@ It creates an undirected graph with `n` vertices and `0` edges.
 
 **alias**
 
-- `DSU`, `DisjointSetUnion`, `UnionFind`, `UnionFindTree`
+- `DSU`, `UnionFind`
 
 ## Instance Methods
 

data/document_en/lazy_segtree.md

@@ -105,13 +105,29 @@ seg.range_apply(l, r, val)
 
 - `O(log n)`
 
-### max_right.
+### max_right(l){  } -> Integer
 
-[TODO] Someone with some free time will write.
+It applies binary search on the LazySegtree.
 
-### min_left
+**Constraints**
+
+- `0 ≦ l ≦ n`
+
+**Complexity**
+
+- `O(log n)`
+
+### min_left(r){  } -> Integer
 
-[TODO] The code side is not implemented yet.
+It applies binary search on the LazySegtree.
+
+**Constraints**
+
+- `0 ≦ r ≦ n`
+
+**Complexity**
+
+- `O(log n)`
 
 ## Verified
 

data/document_en/max_flow.md

@@ -5,7 +5,7 @@ Library for solving [Maximum flow problem](https://en.wikipedia.org/wiki/Maximum
 
 ## Class Methods.
 
-### new(n = 0) -> MaxFlow
+### new(n) -> MaxFlow
 
 ```ruby
 graph = Maxflow.new(10)

data/document_en/min_cost_flow.md

@@ -4,7 +4,7 @@ It solves [Minimum\-cost flow problem](https://en.wikipedia.org/wiki/Minimum-cos
 
 ## Class Methods.
 
-### new(n = 0) -> MinCostFlow
+### new(n) -> MinCostFlow
 
 ```ruby
 graph = MinCostFlow.new(10)

data/document_en/segtree.md

@@ -4,7 +4,8 @@ Segment Tree
 
 ## Class Methods
 
-### new(n, e, &op) -> Segtree
+### new(n, e){ |x, y| ... } -> Segtree
+### new(n, op, e) -> Segtree
 
 ```rb
 seg = Segtree.new(n, e) { |x, y| ... }
@@ -15,7 +16,9 @@ It creates an array `a` of length `n`. All the elements are initialized to `e`.
 - `block`: returns `op(x, y)`
 - `e`: identity element.
 
-### new(ary, e, &op) -> Segtree
+
+### new(ary, e){ |x, y| ... } -> Segtree
+### new(ary, op, e) -> Segtree
 
 ```rb
 seg = Segtree.new(ary, e) { |x, y| ... }
@@ -106,17 +109,47 @@ seg.max_right(l, &f)
 
 It applies binary search on the segment tree.
 
+It returns an index `r` that satisfies both of the following.
+
+- `r = l` or `f(prod(l, r)) = true`
+- `r = n` or `f(prod(l, r + 1)) = false`
+
+
+**Constraints**
+
+- `f(e) = true`
+- `0 ≦ l ≦ n`
+
+**Complexity**
+
+- `O(log n)`
+
 ### min_left(r, &f) -> Integer
 
 ```ruby
 seg.min_left(r, &f)
 ```
 
-It applies binary search on the segment tree.
+It applies binary search on the segment tree.   
+It returns an index l that satisfies both of the following.
+
+- `l = r` or `f(prod(l, r)) = true`
+- `l = 0` or `f(prod(l - 1, r)) = false`
+
+**Constraints**
+
+- `f(e) = true`
+- `0 ≦ r ≦ n`
+
+**Complexity**
+
+- `O(log n)`
 
 ## Verified
 
 - [ALPC: J \- Segment Tree](https://atcoder.jp/contests/practice2/tasks/practice2_j)
+  - [AC Code(884ms) max_right](https://atcoder.jp/contests/practice2/submissions/23196480)
+  - [AC Code(914ms) min_left](https://atcoder.jp/contests/practice2/submissions/23197311)
 - [F \- Range Xor Query](https://atcoder.jp/contests/abc185/tasks/abc185_f)
   - [AC Code(1538ms)](https://atcoder.jp/contests/abc185/submissions/18746817): Segtree(xor)
   - [AC Code(821ms)](https://atcoder.jp/contests/abc185/submissions/18769200): FenwickTree(BIT) xor