数論・組み合わせ・その他のアルゴリズム系ライブラリのドキュメント改善

[Copilot]

10個のアルゴリズムライブラリに包括的なドキュメントと実用的な使用例を追加しました。

改善対象ライブラリ

数論・組み合わせ系

• ext_gcd: 拡張ユークリッド互除法の詳細説明、乗法逆元計算・中国剰余定理での使用例を追加
• factorials: クレートレベルドキュメント、組み合わせ論での使用パターン、競技プログラミングでの典型的な応用例を追加

Union-Find・グラフアルゴリズム系

• union_find: Kruskal法での最小全域木、グラフの連結性判定での実用例を追加
• detect_cycle: 無向・有向グラフでのサイクル検出の詳細説明、DAG判定での応用例を追加
• strongly_connected_components: 包括的なクレートレベルドキュメント、2-SATでの使用例を含む詳細説明を追加

その他のアルゴリズム系

• cumulative_sum_2d: 二次元領域クエリでの使用パターン、imos法との組み合わせ例を追加
• sliding_window: モノトニックデックアルゴリズムの詳細説明、RMQでの応用例を追加
• auxiliary_tree: auxiliary treeの概念説明、LCAとの組み合わせ、木上クエリでの使用例を追加
• arithmetic_series: 等差数列和の数学的応用例、競技プログラミングでの実用パターンを追加
• next_permutation: 順列生成での詳細説明、全探索パターンでの使用例を追加

主な改善内容

ドキュメント品質向上

• クレートレベルドキュメント: アルゴリズムの概要、計算量、主な用途を明確に記述
• 関数レベルドキュメント: 各public APIの詳細説明、パラメータ・戻り値・パニック条件を網羅
• 実用的なコード例: doctestとして動作する完全なコード例、競技プログラミングでの典型的な使用パターンを追加

一貫性の確保

• 既存の良いドキュメント（mod_int、dijkstra等）のスタイルに合わせた日本語での説明
• 競技プログラミング文脈での説明を重視
• フォーマットと構造の統一

追加された実用例

• 数論: 乗法逆元計算、中国剰余定理、組み合わせ計算
• グラフ: 最小全域木、強連結成分分解、サイクル検出、DAG判定
• データ構造: 2D累積和、スライディングウィンドウ、Union-Find
• 列挙: 順列生成、全探索パターン

すべてのdoctestが正常に動作することを確認済みです。これらの改善により、競技プログラミングでの実用性が大幅に向上します。

This pull request was created as a result of the following prompt from Copilot chat.

数論・組み合わせ・その他のアルゴリズム系ライブラリのドキュメント改善

以下の数論・組み合わせ・その他のアルゴリズム系ライブラリクレートに包括的なdoc commentと実用的な使用例を追加してください：

対象ライブラリ

数論・組み合わせ系

1. algo/ext_gcd/src/lib.rs

   • 現在：基本的なドキュメントあり
   • 必要：より詳細な説明、実用的な使用例の追加

2. algo/factorials/src/lib.rs

   • 現在：部分的なドキュメント
   • 必要：クレートレベルドキュメント、使用例の拡充、組み合わせ計算パターン

Union-Find・グラフアルゴリズム系

3. algo/union_find/src/lib.rs

   • 現在：良いドキュメントあり
   • 必要：さらなる実用例、競技プログラミングでの典型パターン

4. algo/detect_cycle/src/lib.rs

   • 現在：基本的なドキュメント
   • 必要：より詳細な説明、実用的な使用例

5. algo/strongly_connected_components/src/lib.rs

   • 現在：ドキュメントなし
   • 必要：包括的なクレートレベルドキュメント、全関数の詳細説明

その他のアルゴリズム系

6. algo/cumulative_sum_2d/src/lib.rs

   • 現在：基本的なドキュメント
   • 必要：より詳細な説明、実用パターンの追加

7. algo/sliding_window/src/lib.rs

   • 現在：基本的なドキュメント
   • 必要：より詳細な説明、実用的な使用例

8. algo/auxiliary_tree/src/lib.rs

   • 現在：ドキュメントなし
   • 必要：包括的なクレートレベルドキュメント、詳細な説明

9. algo/arithmetic_series/src/lib.rs

   • 現在：良いドキュメント
   • 必要：軽微な改善、追加の使用例

10. algo/next_permutation/src/lib.rs

    • 現在：基本的なドキュメント
    • 必要：より詳細な説明、実用的な使用例

ドキュメント要件

クレートレベルドキュメント（lib.rsの先頭）

• アルゴリズムの概要説明
• 時間計算量・空間計算量
• 主な用途・適用場面（特に競技プログラミングでの使用例）
• 基本的な使用例

関数・構造体レベルドキュメント

• 各public APIの詳細説明
• パラメータの説明
• 戻り値の説明
• 計算量情報
• パニック条件（該当する場合）
• 実用的なコード例

Examples セクション

• 基本的な使い方
• 競技プログラミングでの典型的な使用パターン
• 数論・組み合わせ・グラフ問題での実用例
• doctestとして動作する完全なコード例

具体的な改善内容

数論・組み合わせ系

• ext_gcd: 拡張ユークリッド互除法の詳細説明、逆元計算での使用例
• factorials: 組み合わせ論での使用パターン、競技プログラミングでの典型的な応用例

Union-Find・グラフ系

• union_find: 最小全域木、連結性判定での使用パターン
• detect_cycle: 無向グラフでのサイクル検出、実用的な応用例
• strongly_connected_components: 強連結成分分解の詳細説明、有向グラフでの応用

その他のアルゴリズム系

• cumulative_sum_2d: 二次元領域クエリでの使用パターン
• sliding_window: 最小値・最大値取得の効率的な実装
• auxiliary_tree: auxiliary treeの概念説明、LCAとの組み合わせ
• arithmetic_series: 等差数列和の応用パターン
• next_permutation: 順列生成での使用例、全探索パターン

実装ガイドライン

1. 日本語でのドキュメント記述

   • 既存のクレート（mod_int、dijkstra等）のスタイルに合わせる
   • 競技プログラミング文脈での説明を含める

2. コード例の品質

   • doctestとして実行可能
   • 実際の競技プログラミング問題で使えるパターン
   • わかりやすい変数名とコメント

3. 一貫性の維持

   • 既存の良いドキュメントのスタイルを参考に
   • フォーマットと構造の統一

4. 実用性重視

   • 理論的説明よりも実際の使い方を重視
   • 競技プログラミングでよく使われるパターンを含める
   • 数論・グラフ・その他のアルゴリズム問題での典型的なパターンを含める

各ライブラリに対して適切なレベルのドキュメントを追加し、数論・組み合わせ・その他のアルゴリズム処理ライブラリとしての使いやすさを向上させてください。

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.