algpseudocode.sty の algorithmic 環境で「入力」や「出力」を作る

この記事では algpseudocode.sty の algorithmic 環境を用いて LaTeX で擬似コードを書く場合に、アルゴリズムの「入力」や「出力」を下図のように表示するための方法を紹介します*1。

f:id:tobetakoyaki:20210617015000p:plain:h350 — 冒頭に「Input」と「Output」を追加してアルゴリズムの機能を説明する様子

具体的には、もともとこの sty ファイルに定義されている「Require」や「Ensure」を出力するコマンドと同じように定義をする方法を紹介していきます。

なお、この記事は私の LaTeX 擬似コード系ブログとしては第2弾になります。第1弾はこんな記事でした。第3弾も予定しています*2。
tobetakoyaki.hatenablog.com

概要
algorithm.sty と algpseudocode.sty
algnewcommand で新しいコマンドを定義する
参考文献

概要

先に完成コードを提示します。詳しい説明は本文をお読みください。

\usepackage[chapter]{algorithm}%
\usepackage[noend]{algpseudocode}%
%
% augmenting the commands of algorithmicx package
\algnewcommand\algorithmicinput{{\bfseries\gtfamily 入力}}%
\algnewcommand\algorithmicoutput{{\bfseries\gtfamily 出力}}%
\algnewcommand\AlgInput{\item[\algorithmicinput]}%
\algnewcommand\AlgOutput{\item[\algorithmicoutput]}%
\algrenewcommand\Return{\State\textbf{return} }%

algorithm.sty と algpseudocode.sty

LaTeX でアルゴリズムの擬似コードを書く際に役立つパッケージに algorithm.sty と algpseudocode.sty があります。それぞれのパッケージの頒布元を以下に引用します。

algorithmパッケージ: CTAN: Package algorithms
algpseudocodeパッケージ: CTAN: Package algorithmicx

この記事ではこの2つのパッケージの基本的な使い方は紹介しません。上記のサイトに掲載のドキュメントや以下に引用する解説記事を参照ください。

解説記事①
qiita.com

解説記事②
li-feel.hatenablog.com

algnewcommand で新しいコマンドを定義する

algorithmic 環境では

コマンドの定義や再定義には \algnewcommand や \algrenewcommand を使う*3
\item を使うと行頭に文字を出力できる*4

これを踏まえると、「入力」を行頭に出すコマンドは次のように定義できます。

\algnewcommand\algorithmicinput{{\bfseries\gtfamily 入力}}%
\algnewcommand\AlgInput{\item[\algorithmicinput]}%

↓使用例はこんな感じです*5。

\begin{algorithm}
  \caption{Factorial}
  \label{alg:factorial}
  \begin{algorithmic}[1]
    \AlgInput $n$
    \State $P \leftarrow 1$
    \For{$i=2,\dotsc,n$}
      \State $P \leftarrow P \times i$
    \EndFor
    \Return $P$
  \end{algorithmic}
\end{algorithm}