@@ -109,11 +109,18 @@ Markdown では、改行のために行末を意図的に 2 個の空白にす
109109- ` main ` 関数内の全ての ` return 0; ` の前の行には、空行が 1 行入っている。
110110- ` main ` 関数の最後の行にも ` return 0; ` が記述されている。
111111
112+ ### ドキュメント(共通)
113+ - TeX 数式の囲みが ` $ $ ` である(` \( \) ` などでない)。
114+ - TeX 数式の前後は、空白または改行である(たとえ前後が句読点であっても、` $ ` との間に空白を入れている)。
115+ - TeX 数式での絶対値記号による囲みが ` \lvert \rvert ` である(` | | ` などでない)。
116+ - TeX 数式の等号付き不等号や否定記号は ` e ` で終わるコマンド(` \ge ` , ` \le ` , ` \ne ` )で記述されている(` \geq ` , ` \leq ` , ` \neq ` などでない)。
117+ - 複数のインライン数式が連続して並ぶ場合、1 つの TeX 数式として記述されている(数式の外の ` , ` や ` 、 ` などで区切られた複数の TeX 数式になっていない)。
118+
112119### ライブラリのドキュメント
113120- ライブラリのドキュメントは箇条書きを中心とした簡潔な記述である。
114121- 先頭に Jekyll Front Matter がある。
115122 - ` documentation_of ` が対応するヘッダファイルを指している。
116- - ` title ` は人間にとって分かりやすい名前になっており、適切に TeX 数式を使用している 。
123+ - ` title ` は人間にとって分かりやすいタイトルになっている( TeX 数式を使用してもよい) 。
117124- 「前提: 」や「備考: 」などにおけるコロンは、半角コロンと半角スペースである(「前提:」「前提:」「前提 : 」などでない)。
118125- 自動で挿入される、対応するヘッダファイルの include 指令のテキストを必要なく記述していない。
119126 - 使用例のソースコードなどの、include 指令が実際に必要である例は除く。
@@ -124,23 +131,19 @@ Markdown では、改行のために行末を意図的に 2 個の空白にす
124131 - ソースコードによる例だけで説明を済ませていない。
125132- ` ## 計算量 ` の節で、計算量の種類を略して「時間」または「空間」と表記する場合、` 時間 $O(n)$ ` のように計算量よりも前に書く(` $O(n)$ 時間 ` などでない)。
126133- ` ## 計算量 ` の節に記載されている、big-O 記法などのランダウの記法による計算量オーダーは、ランダウの記法の数学的な定義に従った厳密な値であり、ランダウの記法を用いることが自然なものである。
127- - 関数 $f$ を用いて計算量オーダーを $O(f)$ と記述する場合、$f$ は正しい上界である(悪い例は、入力サイズ $n$ についての漸近計算量オーダーが実際は $\Theta(n\log n)$ であるのにもかかわらず、$O(n)$ と記述するなどである)。
128- - 関数 $f$ を用いて計算量オーダーを $\Theta(f)$ と記述する場合、計算量オーダーは実際に $f$ で上からも下からも抑えられる(悪い例は、入力サイズ $n$ についての漸近計算量オーダーが実際は $O(n)$ であるのにもかかわらず、$\Theta(n \log n)$ と記述するなどである)。
129- - 関数 $f$ を用いて計算量オーダーを $\Omega(f)$ と記述する場合、$f$ は正しい下界である。
134+ - 関数 $f$ を用いて計算量オーダーを $O(f)$ と記述する場合、 $f$ は正しい上界である(悪い例は、入力サイズ $n$ についての漸近計算量オーダーが実際は $\Theta(n\log n)$ であるのにもかかわらず、 $O(n)$ と記述するなどである)。
135+ - 関数 $f$ を用いて計算量オーダーを $\Theta(f)$ と記述する場合、計算量オーダーは実際に $f$ で上からも下からも抑えられる(悪い例は、入力サイズ $n$ についての漸近計算量オーダーが実際は $O(n)$ であるのにもかかわらず、 $\Theta(n \log n)$ と記述するなどである)。
136+ - 関数 $f$ を用いて計算量オーダーを $\Omega(f)$ と記述する場合、 $f$ は正しい下界である。
130137 - ランダウの記法を用いる場合、非負整数 $N$ に対する $(\log N)^{-1}$ のように値が小さい場合に未定義になる式を用いていても修正する必要はない。特に、多変数のランダウの記法であっても、一部の変数のみを無限大に飛ばして他の変数を小さい値に固定した場合を考慮して過度に複雑な式にする必要はない。
131138 - big-O 記法を用いて厳密に記述するのが難しい計算量であれば、適宜 $\tilde{O}$ や $\mathrm{poly}$ などを用いている。
132- - このライブラリで特殊化した特定の定数に比例する場合は、ランダウの記法以外を用いてその旨を説明している(悪い例は、$O(128)$ などである)。
139+ - このライブラリで特殊化した特定の定数に比例する場合は、ランダウの記法以外を用いてその旨を説明している(悪い例は、 $O(128)$ などである)。
133140- ` ## 計算量 ` の節で、平均計算量や期待計算量などの最悪計算量と償却計算量以外の計算量を述べる場合は、その旨を説明している。
134141- 数式として書くべきである制約などの記述は、バッククォートによる囲みなどではなく TeX 数式として書いてある。
135142 - 1 文字の値(数学定数などローマン体で表記されるべき値を除く)はイタリック体である(` \mathrm{ } ` などを使用していない)。
136143 - 引数などの、通常の数式に現れないような 2 文字以上の文字列で表される値を数式中で使用する場合は、先に別の文字でおいている。
137144 - おいた文字は、イタリック体の 1 文字もしくはイタリック体の 1 文字に上付きまたは下付きの数や文字列が付いたものである。
138145 - 上付きまたは下付きの文字列が英字 1 文字(数学定数などローマン体で表記されるべき値を除く)であれば、イタリック体になっている(` \mathrm{ } ` などを使用していない)。
139146 - 上付きまたは下付きの文字列が、ローマン体で表記されるべき値または 2 文字以上の文字列であれば、` \mathrm{ } ` を使用している。
140- - TeX 数式の囲みが ` $ $ ` である(` \( \) ` などでない)。
141- - TeX 数式での絶対値記号による囲みが ` \lvert \rvert ` である(` | | ` などでない)。
142- - TeX 数式の等号付き不等号や否定記号は ` e ` で終わるコマンド(` \ge ` , ` \le ` , ` \ne ` )で記述されている(` \geq ` , ` \leq ` , ` \neq ` などでない)。
143- - 複数のインライン数式が連続して並ぶ場合、1 つの TeX 数式として記述されている(数式の外の ` , ` や ` 、 ` などで区切られた複数の TeX 数式になっていない)。
144147- ライブラリのドキュメント中の C++ ソースコードの例は「``` C++」から「 ``` 」までによって囲まれている(特に、先頭は「``` 」や「 ``` c++」「```cpp」などでない)。
145148
146149### リポジトリのドキュメント
0 commit comments