From 0f01e0c926ea4faa5c82b6c96b7f961dd69578b4 Mon Sep 17 00:00:00 2001 From: Kato Hiroki Date: Sat, 12 Sep 2020 08:19:58 +0900 Subject: [PATCH 1/5] [WIP] Add README (#3) --- README.ja.md | 117 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 119 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 236 insertions(+) create mode 100644 README.ja.md create mode 100644 README.md diff --git a/README.ja.md b/README.ja.md new file mode 100644 index 0000000..85ab738 --- /dev/null +++ b/README.ja.md @@ -0,0 +1,117 @@ +# ac-library-python + +## 説明 + +ac-library-pythonは、[AtCoder Library (ACL)](https://atcoder.jp/posts/517)のPython移植版です。 詳しくは、[公式情報](#公式情報)をご参照ください. + +## 進捗状況 + +**注: 現時点ではテストコードがないため、ご利用には十分ご注意ください。** + +### 実装済み + +#### グラフ + ++ [Disjoint Set Union (DSU)](https://github.com/not522/ac-library-python/blob/master/atcoder/dsu.py) - [通称、蟻本](https://www.amazon.co.jp/%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%9F%E3%83%B3%E3%82%B0%E3%82%B3%E3%83%B3%E3%83%86%E3%82%B9%E3%83%88%E3%83%81%E3%83%A3%E3%83%AC%E3%83%B3%E3%82%B8%E3%83%96%E3%83%83%E3%82%AF-%E7%AC%AC2%E7%89%88-%EF%BD%9E%E5%95%8F%E9%A1%8C%E8%A7%A3%E6%B1%BA%E3%81%AE%E3%82%A2%E3%83%AB%E3%82%B4%E3%83%AA%E3%82%BA%E3%83%A0%E6%B4%BB%E7%94%A8%E5%8A%9B%E3%81%A8%E3%82%B3%E3%83%BC%E3%83%87%E3%82%A3%E3%83%B3%E3%82%B0%E3%83%86%E3%82%AF%E3%83%8B%E3%83%83%E3%82%AF%E3%82%92%E9%8D%9B%E3%81%88%E3%82%8B%EF%BD%9E-%E7%A7%8B%E8%91%89-%E6%8B%93%E5%93%89-ebook/dp/B00CY9256C/ref=tmm_kin_swatch_0?_encoding=UTF8&qid=&sr=)では、Union-Find木として紹介されています。 + +### 準備中 + +#### データ構造 + ++ fenwicktree ++ segtree ++ lazysegtree ++ string + +#### 数学 + ++ math ++ convolution ++ modint + +#### グラフ + ++ maxflow ++ mincostflow ++ scc ++ twosat + +## 使い方 + +提出用のコードに本ライブラリの必要な部分をコピー&ペーストしてご利用ください。 + +## よくある質問 + ++ 準備中。 + +## 利用環境、開発環境に関する情報 + +### 利用者、開発者向け情報 + ++ Python 3.8.2 ++ pip + +### 開発者向け情報 + +#### テストフレームワーク、CI + ++ 準備中。 + +#### 任意のツール + ++ 準備中。 + +## 本レポジトリに貢献する方法 + +ターミナルに以下のコマンドを貼り付けてください(注: $マークは、コマンドを実行する際には不要です)。 + +```md +$ mkdir your_dir_name +$ cd your_dir_name +$ git clone git@github.com:not522/ac-library-python.git +``` + +1. 作業を始める前に、Issueを立てるか、Pull Request(PR)の草案を用意するといいと思います。 +2. Pull Request(PR)を作成し、全てのテストが通ることを確認してください。 + +## 連絡方法 + ++ 準備中。 + +## 公式情報 + +[AtCoder Library (ACL) - AtCoder](https://atcoder.jp/posts/517) + +[AtCoder Library - Codeforces](https://codeforces.com/blog/entry/82400) + +[AtCoder Library (ACL)のGitHubレポジトリ](https://github.com/atcoder/ac-library) + +## 関連プロジェクト + +[ac-library-c](https://github.com/siumai1223/ac-library-c) - C版。 + +[single-file-ac-library](https://github.com/TumoiYorozu/single-file-ac-library) - [公式ライブラリ](https://atcoder.jp/posts/517)を一つのファイルにまとめて利用できます。また、[公式ドキュメント](https://tumoiyorozu.github.io/single-file-ac-library/document_ja/)をブラウザで見ることもできます。 + +[ac-library-cs](https://github.com/key-moon/ac-library-cs) - C#版。 + +[ac-library-d](https://github.com/arkark/ac-library-d) - D版。 + +[ac-library-go](https://github.com/monkukui/ac-library-go) - Go版。 + +[AtCoderLibraryForJava](https://github.com/NASU41/AtCoderLibraryForJava) - Java版。 + +[ACL.jl](https://github.com/abap34/ACL.jl) - Julia版。 + +[ac-library-kt](https://github.com/da-louis/ac-library-kt) - Kotlin版。[AtCoderLibraryForJava](https://github.com/NASU41/AtCoderLibraryForJava)に基づいて作成されています。 + +[Nim-ACL](https://github.com/zer0-star/Nim-ACL) - Nim版。 + +[ACL-Python](https://github.com/Mitarushi/ACL-Python) - PyPy版。 + +[ac-library-ruby](https://github.com/universato/ac-library-rb) - Ruby版。 + +[ac-library-rs](https://github.com/rust-lang-ja/ac-library-rs) - Rust版。 + +## ライセンス + +[CC0](https://creativecommons.org/share-your-work/public-domain/cc0) diff --git a/README.md b/README.md new file mode 100644 index 0000000..3379415 --- /dev/null +++ b/README.md @@ -0,0 +1,119 @@ +# ac-library-python + +[日本語のREADME](README.ja.md) + +## Description + +ac-library-python is a Python port of [AtCoder Library (ACL)](https://atcoder.jp/posts/517). For more information, see [References](#References). + +## Progress + +**Note: There is no test code at this time.** + +### Implemented + +#### Graph + ++ [Disjoint Set Union (DSU)](https://github.com/not522/ac-library-python/blob/master/atcoder/dsu.py) - Also called as Union-Find Tree in [ant book](https://www.amazon.co.jp/%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%9F%E3%83%B3%E3%82%B0%E3%82%B3%E3%83%B3%E3%83%86%E3%82%B9%E3%83%88%E3%83%81%E3%83%A3%E3%83%AC%E3%83%B3%E3%82%B8%E3%83%96%E3%83%83%E3%82%AF-%E7%AC%AC2%E7%89%88-%EF%BD%9E%E5%95%8F%E9%A1%8C%E8%A7%A3%E6%B1%BA%E3%81%AE%E3%82%A2%E3%83%AB%E3%82%B4%E3%83%AA%E3%82%BA%E3%83%A0%E6%B4%BB%E7%94%A8%E5%8A%9B%E3%81%A8%E3%82%B3%E3%83%BC%E3%83%87%E3%82%A3%E3%83%B3%E3%82%B0%E3%83%86%E3%82%AF%E3%83%8B%E3%83%83%E3%82%AF%E3%82%92%E9%8D%9B%E3%81%88%E3%82%8B%EF%BD%9E-%E7%A7%8B%E8%91%89-%E6%8B%93%E5%93%89-ebook/dp/B00CY9256C/ref=tmm_kin_swatch_0?_encoding=UTF8&qid=&sr=). + +### Work in progress + +#### Data structure + ++ fenwicktree ++ segtree ++ lazysegtree ++ string + +#### Math + ++ math ++ convolution ++ modint + +#### Graph + ++ maxflow ++ mincostflow ++ scc ++ twosat + +## Usage + +Copy and paste the library into your code. + +## FAQ + ++ Comming soon. + +## Requirement + +### For all users + ++ Python 3.8.2 ++ pip + +### For developer + +#### Test framework and CI + ++ Comming soon. + +#### Optional + ++ Comming soon. + +## How to contribute + +Paste the following commands at a Terminal prompt. + +```md +$ mkdir your_dir_name +$ cd your_dir_name +$ git clone git@github.com:not522/ac-library-python.git +``` + +1. Create an issue or a draft PR before you start working. +2. Make a PR and pass tests. + +## Contact + ++ Comming soon. + +## References + +[AtCoder Library (ACL) - AtCoder](https://atcoder.jp/posts/517) + +[AtCoder Library - Codeforces](https://codeforces.com/blog/entry/82400) + +[AtCoder Library (ACL) - GitHub repository](https://github.com/atcoder/ac-library) + +## Related Projects + +[ac-library-c](https://github.com/siumai1223/ac-library-c) - C port. + +[single-file-ac-library](https://github.com/TumoiYorozu/single-file-ac-library) - [The official library](https://atcoder.jp/posts/517) is made available as a single file. You can also view [the official documentation](https://tumoiyorozu.github.io/single-file-ac-library/document_ja/) in your favorite browser. + +[ac-library-cs](https://github.com/key-moon/ac-library-cs) - C# port. + +[ac-library-d](https://github.com/arkark/ac-library-d) - D port. + +[ac-library-go](https://github.com/monkukui/ac-library-go) - Go port. + +[AtCoderLibraryForJava](https://github.com/NASU41/AtCoderLibraryForJava) - Java port. + +[ACL.jl](https://github.com/abap34/ACL.jl) - Julia port. + +[ac-library-kt](https://github.com/da-louis/ac-library-kt) - Kotlin port. This project is based on [Java port](https://github.com/NASU41/AtCoderLibraryForJava). + +[Nim-ACL](https://github.com/zer0-star/Nim-ACL) - Nim port. + +[ACL-Python](https://github.com/Mitarushi/ACL-Python) - PyPy port. + +[ac-library-ruby](https://github.com/universato/ac-library-rb) - Ruby port. + +[ac-library-rs](https://github.com/rust-lang-ja/ac-library-rs) - Rust port. + +## LICENSE + +[CC0](https://creativecommons.org/share-your-work/public-domain/cc0) From e53929f4e6f88553c301ce8686e39f05e1ea1d8b Mon Sep 17 00:00:00 2001 From: Kato Hiroki Date: Sat, 12 Sep 2020 21:30:52 +0900 Subject: [PATCH 2/5] Update README (#3) --- README.ja.md | 21 ++++++++++++--------- README.md | 21 ++++++++++++--------- 2 files changed, 24 insertions(+), 18 deletions(-) diff --git a/README.ja.md b/README.ja.md index 85ab738..b303860 100644 --- a/README.ja.md +++ b/README.ja.md @@ -10,15 +10,18 @@ ac-library-pythonは、[AtCoder Library (ACL)](https://atcoder.jp/posts/517)のP ### 実装済み +#### データ構造 + ++ [Fenwick Tree](https://github.com/atcoder/ac-library/blob/master/document_ja/fenwicktree.md) + #### グラフ -+ [Disjoint Set Union (DSU)](https://github.com/not522/ac-library-python/blob/master/atcoder/dsu.py) - [通称、蟻本](https://www.amazon.co.jp/%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%9F%E3%83%B3%E3%82%B0%E3%82%B3%E3%83%B3%E3%83%86%E3%82%B9%E3%83%88%E3%83%81%E3%83%A3%E3%83%AC%E3%83%B3%E3%82%B8%E3%83%96%E3%83%83%E3%82%AF-%E7%AC%AC2%E7%89%88-%EF%BD%9E%E5%95%8F%E9%A1%8C%E8%A7%A3%E6%B1%BA%E3%81%AE%E3%82%A2%E3%83%AB%E3%82%B4%E3%83%AA%E3%82%BA%E3%83%A0%E6%B4%BB%E7%94%A8%E5%8A%9B%E3%81%A8%E3%82%B3%E3%83%BC%E3%83%87%E3%82%A3%E3%83%B3%E3%82%B0%E3%83%86%E3%82%AF%E3%83%8B%E3%83%83%E3%82%AF%E3%82%92%E9%8D%9B%E3%81%88%E3%82%8B%EF%BD%9E-%E7%A7%8B%E8%91%89-%E6%8B%93%E5%93%89-ebook/dp/B00CY9256C/ref=tmm_kin_swatch_0?_encoding=UTF8&qid=&sr=)では、Union-Find木として紹介されています。 ++ [Disjoint Set Union (DSU)](https://github.com/atcoder/ac-library/blob/master/document_ja/dsu.md) ### 準備中 #### データ構造 -+ fenwicktree + segtree + lazysegtree + string @@ -40,6 +43,8 @@ ac-library-pythonは、[AtCoder Library (ACL)](https://atcoder.jp/posts/517)のP 提出用のコードに本ライブラリの必要な部分をコピー&ペーストしてご利用ください。 +また、依存関係にあるライブラリを一つのファイルにまとめる機能を提供する予定です。 + ## よくある質問 + 準備中。 @@ -55,11 +60,13 @@ ac-library-pythonは、[AtCoder Library (ACL)](https://atcoder.jp/posts/517)のP #### テストフレームワーク、CI -+ 準備中。 ++ [Pytest](https://docs.pytest.org/en/stable/) ++ [GitHub Actions](https://docs.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions) -#### 任意のツール +#### Lint -+ 準備中。 ++ [flake8](https://pypi.org/project/flake8/) ++ [pep8-naming](https://pypi.org/project/pep8-naming/) ## 本レポジトリに貢献する方法 @@ -74,10 +81,6 @@ $ git clone git@github.com:not522/ac-library-python.git 1. 作業を始める前に、Issueを立てるか、Pull Request(PR)の草案を用意するといいと思います。 2. Pull Request(PR)を作成し、全てのテストが通ることを確認してください。 -## 連絡方法 - -+ 準備中。 - ## 公式情報 [AtCoder Library (ACL) - AtCoder](https://atcoder.jp/posts/517) diff --git a/README.md b/README.md index 3379415..f0fd000 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,18 @@ ac-library-python is a Python port of [AtCoder Library (ACL)](https://atcoder.jp ### Implemented +#### Data structure + ++ [Fenwick Tree](https://github.com/atcoder/ac-library/blob/master/document_en/fenwicktree.md) + #### Graph -+ [Disjoint Set Union (DSU)](https://github.com/not522/ac-library-python/blob/master/atcoder/dsu.py) - Also called as Union-Find Tree in [ant book](https://www.amazon.co.jp/%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%9F%E3%83%B3%E3%82%B0%E3%82%B3%E3%83%B3%E3%83%86%E3%82%B9%E3%83%88%E3%83%81%E3%83%A3%E3%83%AC%E3%83%B3%E3%82%B8%E3%83%96%E3%83%83%E3%82%AF-%E7%AC%AC2%E7%89%88-%EF%BD%9E%E5%95%8F%E9%A1%8C%E8%A7%A3%E6%B1%BA%E3%81%AE%E3%82%A2%E3%83%AB%E3%82%B4%E3%83%AA%E3%82%BA%E3%83%A0%E6%B4%BB%E7%94%A8%E5%8A%9B%E3%81%A8%E3%82%B3%E3%83%BC%E3%83%87%E3%82%A3%E3%83%B3%E3%82%B0%E3%83%86%E3%82%AF%E3%83%8B%E3%83%83%E3%82%AF%E3%82%92%E9%8D%9B%E3%81%88%E3%82%8B%EF%BD%9E-%E7%A7%8B%E8%91%89-%E6%8B%93%E5%93%89-ebook/dp/B00CY9256C/ref=tmm_kin_swatch_0?_encoding=UTF8&qid=&sr=). ++ [Disjoint Set Union (DSU)](https://github.com/atcoder/ac-library/blob/master/document_en/dsu.md) ### Work in progress #### Data structure -+ fenwicktree + segtree + lazysegtree + string @@ -42,6 +45,8 @@ ac-library-python is a Python port of [AtCoder Library (ACL)](https://atcoder.jp Copy and paste the library into your code. +We also plan to provide a feature to combine dependent libraries into a single file. + ## FAQ + Comming soon. @@ -57,11 +62,13 @@ Copy and paste the library into your code. #### Test framework and CI -+ Comming soon. ++ [Pytest](https://docs.pytest.org/en/stable/) ++ [GitHub Actions](https://docs.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions) -#### Optional +#### Lint -+ Comming soon. ++ [flake8](https://pypi.org/project/flake8/) ++ [pep8-naming](https://pypi.org/project/pep8-naming/) ## How to contribute @@ -76,10 +83,6 @@ $ git clone git@github.com:not522/ac-library-python.git 1. Create an issue or a draft PR before you start working. 2. Make a PR and pass tests. -## Contact - -+ Comming soon. - ## References [AtCoder Library (ACL) - AtCoder](https://atcoder.jp/posts/517) From f5a457d8773956c2939e516cc8948e7f05a80e85 Mon Sep 17 00:00:00 2001 From: Kato Hiroki Date: Sun, 13 Sep 2020 11:19:27 +0900 Subject: [PATCH 3/5] Rename from README.ja.md to README_ja.md --- README.ja.md => README_ja.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.ja.md => README_ja.md (100%) diff --git a/README.ja.md b/README_ja.md similarity index 100% rename from README.ja.md rename to README_ja.md From f7f2a91b1f286b705f238df214ab4bf4b1cf22c8 Mon Sep 17 00:00:00 2001 From: Kato Hiroki Date: Sun, 13 Sep 2020 11:22:48 +0900 Subject: [PATCH 4/5] Pending descriptions of how to contribute --- README.md | 11 +---------- README_ja.md | 11 +---------- 2 files changed, 2 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index f0fd000..fd21157 100644 --- a/README.md +++ b/README.md @@ -72,16 +72,7 @@ We also plan to provide a feature to combine dependent libraries into a single f ## How to contribute -Paste the following commands at a Terminal prompt. - -```md -$ mkdir your_dir_name -$ cd your_dir_name -$ git clone git@github.com:not522/ac-library-python.git -``` - -1. Create an issue or a draft PR before you start working. -2. Make a PR and pass tests. ++ Comming soon. ## References diff --git a/README_ja.md b/README_ja.md index b303860..e959969 100644 --- a/README_ja.md +++ b/README_ja.md @@ -70,16 +70,7 @@ ac-library-pythonは、[AtCoder Library (ACL)](https://atcoder.jp/posts/517)のP ## 本レポジトリに貢献する方法 -ターミナルに以下のコマンドを貼り付けてください(注: $マークは、コマンドを実行する際には不要です)。 - -```md -$ mkdir your_dir_name -$ cd your_dir_name -$ git clone git@github.com:not522/ac-library-python.git -``` - -1. 作業を始める前に、Issueを立てるか、Pull Request(PR)の草案を用意するといいと思います。 -2. Pull Request(PR)を作成し、全てのテストが通ることを確認してください。 ++ 準備中。 ## 公式情報 From 80c6b6eafc4bb6d858569e316a1be6161d5c40fc Mon Sep 17 00:00:00 2001 From: Kato Hiroki Date: Sun, 13 Sep 2020 23:00:44 +0900 Subject: [PATCH 5/5] Fix link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fd21157..e34f28a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ac-library-python -[日本語のREADME](README.ja.md) +[日本語のREADME](README_ja.md) ## Description