Other language English version(英語バージョン)
This file is for Japanese to read.
The following files are written in English: (英語で読みたい方は次のファイルを)
ac-library-rb
ac-library-rbは、AtCoder Library (ACL)のRuby版です。
ACLの詳細は、以下をご覧ください.
- AtCoder Library(ACL)とは
- コード
ライブラリの使い方
公式に、ac-library-rbの利用として、以下の方法を想定しています。
- 直接コピペして使う方法
libディレクトリに、ac-library-rbのライブラリのコードがあります。lib_lockディレクトリに、Gem用にモジュール化されたコードがあります。 (別途モジュール化するの、ちょっとトリッキーですが……)
- Gemとして使う方法(詳細は後述)
他に、有志作成のバンドルツールexpander-rb(by surpaceさん)を利用する方法もあります。
目次は、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のライブラリを使えるようにするには、下記のように書きます。
require "ac-library-rb/all"
dsu = AcLibraryRb::DSU.new
include AcLibraryRb
dsu = DSU.new
include AcLibraryRbとモジュールをインクルードすることで、
何度もAcLibraryRbといわゆる名前空間を書く必要がなくなります。
また、/allなしでrequire "ac-library-rb"とした場合は、include AcLibraryRbも同時に実行されます。
require "ac-library-rb"
dsu = DSU.new
個別ロード
特定のライブラリのみをインストールしたいときは下記のようにac-library-rb/のあとにライブラリ名を指定します。
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バージョン
現在、AtCoderのRubyバージョンは、2.7.1です。
そのため、2.7と最新の3.1でテストをしています。
ただ、開発される方は2.7より古くても動かせるようNumbered parametersなどの使用は控えてもらえると嬉しいです。
ライセンス
とりあえず、本家ライブラリと同じCC0-1.0 Licenseです。
競技プログラミング等で自由に使って下さい。
宣伝・バグ報告などしてもらえると嬉しいです。
ac-library-rbを開発したい方向けの情報(CONTRIBUTEING)
コーディングスタイル
推奨スタイル
- インデントは、半角スペース2文字
- 行末の余計なスペースは削除
RuboCopを使用できる方は、使用してもらえるとありがたいです。
使い方のわからない方は、使う必要がないです。
$gem install rubocop
上記の方法でrubocopをインストールします。
$rubocop <- チェック
$rubocop -a <- 安全に直せるところは自動で修正
$rubocop -A <- 安全でない可能性のところも自動で修正
ディレクトリの説明
libディレクトリ内に各種のデータ構造などのライブラリがあります。
lib_lockは、Gem用にモジュール化させるためlibの内容をコピーする形でモジュール化させています。
bin/lock_lib.rbを実行することで、libからlib_lockにモジュール化させる形でコピーします。
rake copyコマンドを実行すると、bin/lock_lib.rbが実行されるため、この2つは同等です。
なお、rakeコマンドでテストを実行させると、自動的にrequire_relative "./bin/lock_lib.rb"により、コピーが行われます。
このあたりはトリッキーで、予定は未定ですが、今後全てモジュール化される等に統一される可能性があります。
$ rake copy <- `lib`に変更があれば、`./lib_lokc`を更新する。
$ rake test <- 全てのテストを実行
$ rake <- 上2つのcopy & testを実行
その他の情報
RubyのSlackのAtCoderチャンネル
ruby-jp に"atcoder"というチャンネルがあります。
ここで、バグ報告などすると、競プロ詳しい人などが反応しやすいかもしれません。
Slackに4000人近く、atcoderチャンネルに350人ほどの登録者がいるので、お気軽に参加してください。