アルゴリズムとソースコードのリスト
疑似コード用の algorithm2e と、実際のコード用の listings。
アルゴリズムとソースコードのリスト
論文でコードを載せる形は 2 通りあり、LaTeX にはそれぞれ別のツールがあります。疑似コードは、アルゴリズムを理想化して書いたスケッチで、キーワードと数式で組版します。これを扱うのが algorithm2e パッケージです。ソースコードのリストは、実際のコードを等幅フォントでそのまま載せるもので、listings パッケージが扱います。ツールを間違えると手間がかかることが多いので、両方を見ておくと役に立ちます。
algorithm2e で書く疑似コード
\usepackage[ruled,vlined]{algorithm2e}\begin{algorithm}\caption{Train}\While{not converged}{ Update $\theta$\;}\end{algorithm}パッケージのオプションで見た目が決まります。ruled は、アルゴリズムの上下に横罫線を引き、キャプションを上に置きます。多くの投稿先が想定している形式です。vlined は、各ブロックの範囲を示す短い縦線を引くので、深くインデントしなくても入れ子が読み取れます。algorithm 環境は図と同じフロートなので、\caption を持ち、\ref で参照できる番号が付きます。
環境の中では、\While{condition}{body} が、太字のキーワード、条件、字下げしたブロックとしての本体からなるループを組版します。\For、\If、\Return も同じ形です。文は \; で終わります。これは行の終端を出力して、次の行を始めます。入れ忘れるのは初心者の定番の失敗で、行が1つにつながってしまいます。通常の LaTeX なので、$\theta$ のような数式もインラインで使えます。特定のプログラミング言語ではなく、数式の記法で更新規則を説明するのが、疑似コードの目的です。
listings で載せる実際のコード
\usepackage{listings}\begin{lstlisting}[language=Python]def f(x): return x**2\end{lstlisting}lstlisting 環境は、中身をそのまま再現します。空白は保たれ、特殊文字も文字どおりに扱われるので、何もエスケープせずにコードを貼り付けられます。language=Python オプションでその言語のキーワードが強調され、listings は他にも数十の言語に対応しています。既定の出力は装飾のないものです。多くの人は、プリアンブルに一度だけ \lstset{basicstyle=\ttfamily\small, numbers=left} を書いて、ちょうどよいサイズの等幅フォントと行番号を使えるようにしています。コードを貼り付ける代わりにファイルを直接読み込むには、\lstinputlisting[language=Python]{train.py} でディスクから読み込みます。こうすると、論文と実際のソースを同期させておけます。色付きの高品質なシンタックスハイライトが必要なら、minted パッケージがより強力な選択肢です。ただし、外部ツールとシェルエスケープが必要になります。
使い分け
アイデアを伝える論文の本文では疑似コードを使います。付録やツールの説明のように、コードそのものが重要な成果物には、そのまま載せるリストを使います。よくある間違いは、[fragile] オプションを付けずに Beamer のフレームの中へ lstlisting を置くことです。原因の分かりにくいエラーで失敗します。同じ注意は 最初の Beamer スライド にも出てきます。