LaTeXでプログラミングしてみよう（前編）

（再投稿です。大幅な加筆・修正してお送りします。）

久しぶりの投稿になります。三条です。

今回の投稿は、約3年前にサークルの部誌に寄稿した記事を改訂したものになります。有料でしたが、まあ3年経ってるので大丈夫だと思います。~~知らんけど。~~

少し長いので2部構成にします。前編は準備、後編は実践です。かなり丁寧に書き直したので、TeXマクロ入門みたいな感じになっていると思います。

---

# LaTeXとは

レポートや学術系論文の作成において、LaTeXにお世話になっている方も多いと思います。本稿はそんなLaTeXで普段とは別の使い方で遊んでみようといった内容のお話です。

まず、TeXはフリーの「組版処理システム」であり、文字や図などを紙面に配置する作業をコンピュータ上で行います。しかし、TeX単体では使いにくいので、TeXの機能を拡張して一般的な文書を手軽に作成できるようにしたものがLaTeXです。

一般に文書作成ソフトと言われるとWordを思い浮かべるでしょう。もちろん、Wordは文書を作成することもできますし、図なども挿入することが出来ます。ですが、Wordでは見出しの大きさや書体、適切な空白やインデントなど自分で美しいデザインにするのが面倒なことが多いです。一方、LaTeXでは見出しや文字に統一感があり、フォントや大きさを自動で調節してくれるので、美しい文書に仕上がります。

それでは、この洗練されたLaTeX文書を作成するにはどうすれば良いでしょうか。答えは、「コマンド」です。好きなテキストエディタ上でコマンドを入力し、文書のレイアウトを構成します。そして、LaTeXによってそれらを解釈することによってPDF(文書)を作成することが出来ます。このように、文書の構造をコマンドで指定することから、HTMLと同じように「マークアップ言語」の一種でもあります。

本稿では、「マークアップ言語」としての側面ではなく、「プログラミング言語」としての側面に着目します。つまり、四則演算だけでなくソートすら可能です。そんな意外な一面を持っているLaTeXで少し遊んでみましょう。

# 環境

TeX Live 2018
macOS Mojave version 10.14.5

# 準備

LaTeXでプログラミングをするにあたって、いわゆる関数定義やfor文などの構文が書けなければお話になりません。まずは、その基礎知識を紹介します。

## 世界に挨拶

とりあえず、「Hello, World!」することから始めましょう。

```latex
\documentclass[a4paper,uplatex]{jsarticle}
\begin{document}
  Hello, World!
\end{document}
```

TeXにおけるコマンド（命令）はバックスラッシュから始まり、これは以下の2種類に分けられます。

- プリミティブ: TeXに元からあるコマンド
- マクロ: ユーザー定義のコマンド

`\begin{document}`から`\end{document}`のブロックは紙面のようなもので、本文は全てここに書きます。`documentclass[a4paper,uplatex]{jsarticle}`はいわゆるおまじないです。
お好みのテキストエディタに記述したら、ターミナル上で以下のコマンドを実行します。

```bash
uplatex hello.tex
dvipdfmx hello.dvi
```

エラーが出なければ無事にPDFを作成することが出来ます。PDFビューアーで作成したPDFを確認してみましょう。「Hello, World!」と出力されていれば成功です。

## マクロ定義

LaTeXにおけるマクロは、`\def\<MacroName>#1#2...{<Definition>}`または`\newcommand{\<MacroName>}[<Argc>][<Arg1>][<Arg2>][...]{<Definition>}`[^1]で定義します。

[^1]: 省略不可な引数を`{}`で囲い、省略可能な引数を`[]`で囲います。

```latex
\documentclass[a4paper,uplatex]{jsarticle}
\def\hello#1{%
  #1さん、こんにちは。%
}
\begin{document}
  \hello{太郎}
\end{document}
```

```latex
\documentclass[a4paper,uplatex]{jsarticle}
\newcommand{\hello}[1]{%
  #1さん、こんにちは。%
}
\begin{document}
  \hello{太郎}
\end{document}
```

出力：
太郎さん、こんにちは。


ポイント

- `\newcommand`は同名のマクロが既に定義されている場合はエラーを吐きます。反対に、`\def`はマクロの定義を上書きするため、既存のマクロの定義を破壊する可能性があります。単純なマクロを定義する際は`\newcommand`の方が望ましいです。
- `\renewcommand{\<MacroName>}[<Argc>][<Arg1>][<Arg2>][...]{<Definition>}`で既にあるコマンドの定義を置き換えます。あくまで「置き換える」だけなので、元からあったマクロの定義を破壊しません。

### 余談

`\def`と似たような振る舞いをする`\edef`というものがあります。こちらは、定義に含まれるマクロを**完全展開**します。「完全展開」とは、「マクロを定義した時点において、その定義に含まれるマクロを全て展開すること」です。したがって、定義に含まれるマクロを後から再定義しても、`\edef`で定義した中身は変わりません。[^2]

[^2]: `\edef`と似たような振る舞いをするものとして`\let`がありますが、こちらはコマンドを「**参照コピー**」します。つまり、コピーしたコマンドの中身が変更されると、コピー先も同様に変更されます。

```latex
\def\hoge{HOGE}
\edef\fuga{\hoge}
\fuga % 出力：HOGE

\def\hoge{HOGEHOGE}
\fuga % 出力：HOGE
```

また、`{}`によってマクロ定義などを囲むことを「グルーピング」と呼びますが、その中で定義されたマクロや変更されたレジスタの値は「ローカル」なものになります。ただし、マクロ定義の前に`\global`を前置すると、その定義は「**グローバル**」になります。

```latex
\def\foo{A}
{
  \def\foo{X}
  \foo % 出力：X
}
\foo % 出力：A

\def\bar{B}
{
  \global\def\bar{Y}
  \bar % 出力：Y
}
\bar % 出力：Y
```

`\gdef`、`\xdef`はそれぞれ`\global\def`、`\global\edef`の短縮系です。

## 四則演算

次は四則演算です。方法は2通りあります。基本的には好きな方を使ってもらって構いません。

1つ目は従来のTeX言語のようなやり方です。他言語と同様の記法で直感的かつ簡潔に書くことができます。

```latex
\documentclass[a4paper,uplatex]{jsarticle}
\newcount\X
\def\calculation#1#2{%
  \X=#1
  \advance\X #2
  \the\X%
}
\begin{document}
  \[
    2 + 3 = \calculation{2}{3}
  \]
\end{document}
```

出力：

```math
2 + 3 = 5
```

ポイント：

- `\newcount\<VarName>`でカウンタを定義します。同名のカウンタがある場合、後に定義された方が使われます。
- `\advance\<VarName> by <Value>`でカウンタに数値を加算します。コンテキストによっては`by`は不要です。`<Value>`に負の値が入ると減算になります。
- 同様に乗算、除算もサポートされており、それぞれ`\multiply`、`\divide`が対応します。
- `\the`をカウンタの前に前置することで、カウンタの値を出力できます。

2つ目はLaTeX言語のやり方です。定義の前に同名のカウンタがないかチェックが入り、存在すればエラーを吐きます。

```latex
\documentclass[a4paper,uplatex]{jsarticle}
\usepackage{calc}
\newcounter{X}
\newcommand{\calculation}[1]{%
  \setcounter{X}{#1}
  \the\value{X}%
}
\begin{document}
  \[
    2 + 3 = \calculation{2+3}
  \]
\end{document}
```

出力：

```math
2 + 3 = 5
```

ポイント

- `\newcounter{<VarName>}`でカウンタを宣言出来ます。カウンタは変数のようなものです。
- `\setcounter{<VarName>}{<Val>}`でカウンタに値を割り当てます。`<Val>`には整数値が入ります。[calcパッケージ](https://www.ctan.org/pkg/calc)を使うと、`<Val>`の部分に式を入れることができるようになります。

## 条件分岐

条件比較には`\ifnum<Condition>`または`\ifthenelse{<Condition>}{<TrueCase>}{<FalseCase>}`[^3]を使います。どちらを使っても良いです。`\ifthenelse`を使う場合は[ifthenパッケージ](https://www.ctan.org/pkg/ifthen)が必要です。

[^3]: `\ifnum`や`\ifx`のラッパーです。

```latex
\documentclass[a4paper,uplatex]{jsarticle}
\def\adultorchild#1{%
  \ifnum#1<20%
    未成年%
  \else%
    成年%
  \fi%
}
\begin{document}
  18才は\adultorchild{18}です。
\end{document}
```

出力：
18才は未成年です。

ポイント：

- 条件式の比較には`>`、`<`、`=`を使うことが出来ます。`<=`、`>=`は使えません。
- 数値の比較には`\ifnum`、文字列の比較には`\ifx`を使います。その他にも、「奇数かどうか」を判断する場合には`\ifodd`が用意されています。
- 条件式が偽となるケースには`\else`を使います。必要ない場合は省略可能です。また、構文の終わりには**必ず**`\fi`を置きます。うっかり忘れると怒られます。

```latex
\documentclass[a4paper,uplatex]{jsarticle}
\usepackage{ifthen}
\newcommand{\adultorchild}[1]{%
  \ifthenelse{#1 < 20}{%
    未成年%
  }{%
    成年%
  }%
}
\begin{document}
  18才は\adultorchild{18}です。
\end{document}
```

ポイント

- 条件式の比較には`>`、`<`、`=`の他にも`\NOT A < B`、`\NOT A > B`を使うことで、それぞれ`>=`、`<=`を表せます。
- ifthenパッケージには論理和、論理積、論理否定が用意されています。それぞれ`\OR`、`\AND`、`\NOT`を使います。全て大文字です。
- `\ifthenelse`の構文は**必ず**「条件式が真の場合」と「条件式が偽の場合」の二つを記述する必要があります。勝手に片方を省くと怒られます。

## 繰り返し

繰り返し処理も方法は色々ありますがその中の3通りを紹介します。どの方法も最終的な出力は同じになるようにしています。

1つ目は`\@whilenum<Condition>\do{<Stuff>}`[^4]です。使う際は`\makeatletter`が必要です。

[^4]: LaTeXの内部命令として用意されているマクロです。`\loop`と`\repeat`を使う従来の方法のラッパーとなっています。内部命令の仲間として、拡張for文のような振る舞いをする`\@for`もあります。

```latex
\documentclass[a4paper,uplatex]{jsarticle}

\makeatletter

\newcount\Sum
\newcount\K
\def\summation#1#2{%
  \Sum=#1
  \K=#1
  \@whilenum{\K<#2}\do{%
    \advance\K 1
    \advance\Sum \K
  }%
  \the\Sum%
}

\makeatother

\begin{document}
  \[
    \sum_{i=1}^ni=\summation{1}{100}
  \]
\end{document}
```

出力：

```math
  \sum_{i=1}^{100}i = 5050
```


ポイント：

- `\@whilenum`の条件式には`\ifnum`と同様に`<=`や論理否定などを使用することは出来ません。
- 出力に余計な空白を加えないため、マクロ定義や`\do`の後ろのカッコにコメント文字（`%`）を置いています。詳しくは実践編にて。

2つ目はifthenパッケージに同梱されている`\whiledo{<Condition>}{<Stuff>}`です。

```latex
\documentclass[a4paper,uplatex]{jsarticle}
\usepackage{ifthen}

\newcounter{Sum}
\newcounter{K}
\newcommand{\summation}[2]{%
  \setcounter{Sum}{#1}
  \setcounter{K}{#1}
  \whiledo{\value{K} < #2}{%
    \stepcounter{K}
    \addtocounter{Sum}{\value{K}}
  }%
  \the\value{Sum}%
}

\begin{document}
  \[
    \sum_{i=1}^ni=\summation{1}{100}
  \]
\end{document}
```

ポイント：

- 使い方は`\@whilenum`と大して変わりません。ifthenパッケージのマクロなので、条件式の部分に`\NOT`や`\OR`が使えます。

最後は[multidoパッケージ](https://ctan.org/pkg/multido)を用いたやり方です。`\multido{<Initialization>}{<Repetitions>}{<Stuff>}`でC++等の言語でよく見られるforループの要領で記述できます。

```latex
\documentclass[a4paper,uplatex]{jsarticle}
\usepackage{multido}

\newcounter{Sum}
\newcommand{\summation}[2]{%
  \setcounter{Sum}{0}
  \multido{\ix=#1+1}{#2}{%
    \addtocounter{Sum}{\ix}
  }%
  \the\value{Sum}
}
\begin{document}
  \[
    \sum_{i=1}^{100}i = \summation{1}{100}
  \]
\end{document}
```

ポイント：

- `\addtocounter{<ValName>}{<Val>}`でカウンタに値を加算します。
- `\stepcounter{<ValName>}`でカウンタの値をインクリメントします。
- `\multido`の変数はカンマ区切りで複数の宣言が可能で、`\<Var>=<InitialValue>+<Inc>`のように初期値を増分を設定します。また、変数の先頭には”型”を表す文字を入れる必要があります。この変数は**マクロ扱い**なので、参照の際に`\value`を使う必要はありません。
- 型は大きく分けて2つあり、Dimension（`\d` or `\D`）とNumber（`\n` or `\N`）です。Dimensionは1pt、2cm等の寸法を指定し、Numberは3、7.05等などの数値を指定します。
- Number変数には、Interger（`\i` or `\I`）とReal（`\r` or `\R`）という整数と実数に対しての**高速版**が用意されています。
- `\multidostop`を置くと、そのループ処理が終わった後に`\multido`を抜けることが出来ます。
- 現在の繰り返し回数は`\multidocount`で取得出来ます。カウンタ扱いなので、出力には`\the`が必要です。
- `<Repetitions>`には数値のみが入ります。**式を入れることは出来ません。**

## 再帰

もちろん再帰処理も出来ます。しかし、マクロの展開制御が難しいので、慣れないうちはあまりやらない方がいいかもしれません。一般に、再帰処理はwhileループに置き換えることができるので、素直に`\@whilenum`等を使った方法に直した方が良いでしょう。

次のコードは先ほどの`\summation`マクロを再帰を用いて記述したものになります。`\recsummation`が再帰の本体です。

```latex
\documentclass[a4paper,uplatex]{jsarticle}

\newcount\Sum
\newcount\K
\newcount\N
\def\summation#1#2{%
  \Sum=0
  \K=#1
  \N=#2
  \recsummation
  \the\Sum%
}
\def\recsummation{%
  \advance\Sum \K
  \ifnum\K<\N%
    \advance\K 1
    \expandafter\recsummation
  \fi
}

\begin{document}
  \[
    \sum_{i=1}^ni=\summation{1}{100}
  \]
\end{document}
```

ポイント：

- `\expandafter\recsummation`の部分は、単に`\recsummation`としても動作します。ただし、`\summation`の第二引数の値を10000程度にすると、後者の場合はスタックオーバーフローします。
- `\expandafter`[^5]によって`\fi`を最初に評価することで、`\recsummation`が一番最後に呼ばれるようにしています。つまり、**末尾再帰**になっています。

[^5]: `\expandafter\A\B`において、最初に`\A`ではなく`\B`を展開し、その後`\A`を展開するように制御する命令です。

## 配列

元々、LaTeXにはデータ構造がありません。そこで、識別子に番号をつけることで擬似的に配列を再現します。これには**名前参照**という機能を使います。「名前参照」とは、「文字列データを用いて、その文字列と同じ名前をもつ変数を参照すること」です。要は、JavaやRubyで言う「リフレクション」のようなものです。

LaTeXでは`\@namedef`と`\@nameuse`を使って名前参照を実現できます。次のコードは4つの立法数の和を求めるプログラムです。ここでは擬似配列に格納した値をもとに和を求めます。

```latex
\documentclass[a4paper,uplatex]{jsarticle}

\makeatletter

\newcount\Sum
\newcount\K
%% 配列の定義、初期化
\@namedef{arr/0}{1}
\@namedef{arr/1}{8}
\@namedef{arr/2}{27}
\@namedef{arr/3}{64}
%% 4つの立法数の和を求める
\newcommand{\foldarr}{%
  \Sum=0
  \K=0
  \@whilenum{\K<4}\do{%
    \advance\Sum \@nameuse{arr/\the\K}
    \advance\K 1
  }%
  \the\Sum%
}

\makeatother

\begin{document}
  \[
    1^3 + 2^3 + 3^3 + 4^3 = \foldarr
  \]
\end{document}
```

出力：

```math
1^3 + 2^3 + 3^3 + 4^3 = 100
```

ポイント：

- `\@namedef`は与えられた文字列から成るマクロを定義します。例えば、`\@namedef{arr/1}{8}`は`\def\arr/1{8}`と展開されます。
- `\@nameuse`は与えれた文字列から成るマクロの中身を取り出します。例えば`\@nameuse{arr/1}`は`8`と展開されます。
- 数値が来るべき場所に「数字を表す文字列」が来ると、自動的に数値として解釈されます。そのため、`\@nameuse{arr/\the\K}`は最終的に整数に変換されます。

配列なので値の参照だけでなく**値の代入**もできます。ですが、代入に関してはちょっとしたテクニックが必要になります。詳しくは[後編](https://qiita.com/alphalia/items/22f63b42483b541f66f4#%E9%85%8D%E5%88%97%E3%81%B8%E3%81%AE%E4%BB%A3%E5%85%A5)で紹介しています。

# 後編に続く

LaTeXでプログラミングをするのに必要な知識を紹介しました。[LaTeXでプログラミングしてみよう（後編）](https://qiita.com/alphalia/items/22f63b42483b541f66f4)では、これらを使って色々と実践します。

# 参考文献

https://zrbabbler.hatenablog.com/entry/20121107/1352313839

https://zrbabbler.hatenablog.com/entry/20110824/1314212046

https://tex2e.github.io/blog/latex/lifegame

https://texwiki.texjp.org/?TeX入門