LaTeX 算法与代码环境

在LaTeX中使用伪代码来描述算法是常见的需求，LaTeX其实有很多类似名称的宏包，简单辨析一下：（参考 知乎上的一个回答 ）

总得来说通常有两条路子可以选择：

下面主要考虑第一个方式，即使用algorithm2e宏包。

导入algorithm2e宏包时通常顺便加上如下选项

1
2
3
4

\usepackage[ruled,linesnumbered,noline]{algorithm2e}
% ruled 上下添加横线，类似于三线表，此时标题在上面
% linesnumbered 显示行数
% noline 关闭默认体现层级的竖线

算法的主体框架如下，可以添加标题（caption）和标签（label）

1
2
3
4
5
6

\begin{algorithm}

    ...

    \caption{XXX}\label{alg1}
\end{algorithm}

一个简单的例子：

1
2
3
4
5
6
7
8
9
10
11

\begin{algorithm}
    \caption{Euclid's algorithm}
    \KwData{Two nonnegative integers $a$ and $b$}
    \KwResult{Their greatest common divisor $d = \gcd(a, b)$}
    \While{$b \neq 0$}{
        $r \leftarrow a \bmod b$\;
        $a \leftarrow b$\;
        $b \leftarrow r$\;
    }
    $d \leftarrow a$\;
\end{algorithm}

算法的每一行语句可以使用 \; 结尾，这会在文本中加上分号结尾并换行，还可以使用 \\ 强行换行。 除此之外，下面的某些固定语法结构也会导致换行。 算法内部需要数学表达式时，仍然需要 $$ 等来创建数学环境。

算法通常需要使用下面这些预定义宏：

1
2
3
4
5
6
7
8
9

\For{<condition>}{<text loop>}
\While{<condition>}{<text loop>}
\ForEach{<condition>}{<text loop>}
\ForAll{<condition>}{<text loop>}

\lFor{<condition>}{<text loop>}
\lWhile{<condition>}{<text loop>}
\lForEach{<condition>}{<text loop>}
\lForAll{<condition>}{<text loop>}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

\If{<condition>}{<then block>}
\ElseIf{<elseif block>}{<then block>}
\Else{<else block>}

\lIf{<condition>}{<then block>}
\lElseIf{<elseif block>}{<then block>}
\lElse{<else block>}

\uIf{<condition>}{<then block>}
\uElseIf{<elseif block>}{<then block>}
\uElse{<else block>}

\eIf{<condition>}{<then block>}{<else block>}

\leIf{<condition>}{<then block>}{<else block>}

1
2
3
4
5
6
7
8
9
10
11
12
13

\tcc{<comment>}
\tcc*{<comment>}
\tcc*[r]{<comment>}
\tcc*[l]{<comment>}
\tcc*[h]{<comment>}
\tcc*[f]{<comment>}

\tcp{<comment>}
\tcp*{<comment>}
\tcp*[r]{<comment>}
\tcp*[l]{<comment>}
\tcp*[h]{<comment>}
\tcp*[f]{<comment>}

对于循环和条件结构的呈现，还涉及到如下几个选项：

这几个选项既可以在宏包选项中设置，也可以使用下面的命令设置

1
2
3

\SetAlgoLined
\SetAlgoVlined
\SetAlgoNoline

在循环和条件结构中，都支持加上括号包裹的注释选项，例如

1
2
3
4
5
6
7
8
9
10
11
12
13

\lIf




    
(\tcc*[h]{lif comment}){test}{
    text
}
\uIf(\tcc*[f]{uif comment}){test}{
    then text\;
}
\uElseIf(\tcc*[f]{comment}){test}{
    elseif text\;
}
\lElseIf(\tcc*[h]{comment}){test}{
    text
}
\lElse(\tcc*[f]{comment}){text}

宏包还支持自定义一些宏，例如下面定义了与IO宏类似的一个命令 \KwPara{<input>} ，代表算法需要的各种细节参数

1
2
3

\SetKwInput{KwPara}{Parameter}

\KwPara{m,n,$\varepsilon$}

除了这个宏包之外，还可以使用其他方式来实现，例如导入algorithm和algpseudocode这两个宏包，本文暂不讨论具体细节，不过可以明确的是，它的命令风格与algorithm2e是截然不同的。

整理一下LaTeX关于源代码显示的命令，注意这与算法（伪代码）环境的需求是不一样的。

抄录环境 verbatim

LaTeX直接提供verbatim抄录环境，在其中以等宽字体原样排版代码，回车和空格是正常的换行和空位的作用，缩进也是原样保留的；带星号的版本更进一步将空格显示为 ␣ 。使用示例如下

1
2
3
4
5
6
7
8

\begin{verbatim}
#include <iostream>
int main()
{
    std::cout << "Hello, world!" << std::endl;
    return 0;
}
\end{verbatim}

注意这不是代码环境，因为它只是原样输出，并没有提供编程语言的语法高亮功能。

还有与之类似的行内抄录片段或关键字的 \verb 命令

1

\verb<delim><code><delim>

与常见的命令不同， \verb 需要提供自定义的分界符delim来标明代码的前后分界位置，要求前后分界符必须一致，除字母、空格或星号外， 可任意选择使得不与代码本身冲突的符号（习惯上使用 | 符号），例如

1
2
3
4
5

\verb+(a || b)+ %(a || b)

\verb|a\ b| % a\ b

\verb+\ldots+ % \ldots

代码环境 listings

listings宏包是一个功能强大也非常复杂的宏包，用于提供特定编程语言的语法高亮，但是默认的显示字体很丑，排版也很丑，需要经过一番配置才能达到美观的语法高亮显示效果。

1

\usepackage{listings}

通常需要搭配提供颜色的xcolor宏包使用（xcolor是color宏包的增强版）

1

\usepackage{xcolor}

可以定义新的颜色

1
2
3
4
5

\definecolor{dkgreen}{rgb}{0,0.6,0}
\definecolor{gray}{rgb}{0.5,0.5,0.5}
\definecolor{mauve}{rgb}{0.58,0,0.82}

\definecolor{epubblue}{RGB}{1,126,218}

颜色的使用例如 \color{gray} 。注意上面的小写rgb接受的参数为0-1的小数值，而大写RGB接受的是0-256的整数值。

行内代码片段展示： \lstinline|<codes>| ，与 \verb 命令类似，它的分界符可以是任意的，从而避免与代码中的字符冲突，例如

1
2
3

\lstinline!var i:integer;!

\lstinline|int x=1;|

主要用法是导入代码块

1
2
3

\begin{lstlisting}
	<codes>
\end{lstlisting}

也支持从文件中导入代码块（可以设置起止行号来导入源文件中的片段）

1
2

\lstinputlisting[language=Python]{main.py}
\lstinputlisting[language=Python, firstline=2, lastline=12]{main.py}

\lstlistoflistings 命令会将所有添加caption的代码块生成代码目录。

配置既可以在导入特定环境时指定，也可以在导言区进行全局默认设置，在具体环境中以可选参数的形式给出配置，例如

1
2
3
4
5
6
7
8
9
10
11

\begin{lstlisting}[
    language=Python,    % 语言
    numbers=left,       % 行号显示位置
    firstnumber=10      % 行号
]
# Python
def hello():
    print("Hello, world!")

hello()
\end{lstlisting}

或者可以在导言区进行全局默认配置，例如

1
2
3
4
5
6
7
8
9
10
11
12
13

\lstset{
    language=Python                                     % 设置语言
    columns = fixed,                                    % 列距排版
    basicstyle = \linespread{0.8} \ttfamily,            % 设置行距，字体
    numbers = left,                                     % 行号显示设置
    numberstyle = \tiny \color{gray},                   % 设定行号格式
    keywordstyle = \bfseries \color[RGB]{40,40,255},    % 关键字格式
    commentstyle = \color[RGB]{0,96,96},                % 代码注释格式
    stringstyle = \color[RGB]{128,0,0},                 % 字符串格式
    frame = single,                                     % 背景边框
    backgroundcolor = \color[RGB]{245,245,244},         % 背景颜色
    showstringspaces = false,                           % 字符串中的空格显示
}

例如

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

\lstset{
  language=C,                       % 代码语言
  basicstyle=\footnotesize,         % 代码字体大小
  numbers=left,                     % 行号位置
  numberstyle=\tiny\color{gray},    % 行号样式
  stepnumber=2,                     % 行号步进
  numbersep=5pt,                    % 行号与代码之间的距离
  backgroundcolor=\color{white},    % 背景颜色
  showspaces=false,                 % 是否显示空格，用特殊符号替代
  showstringspaces=false,           % 字符串中的空格是否用下划线标出
  showtabs=false,                   % 是否显示制表符，用特殊符号替代
  frame=single,                     % 为代码块添加单线框架
  rulecolor=\color{black},          % 框架颜色
  tabsize=2,                        % 制表符宽度
  captionpos=b,                     % 标题位置（底部）
  breaklines=true,                  % 自动换行
  breakatwhitespace=false,          % 仅在空格处自动换行
  title=\lstname,                   % 显示包含代码的文件名
  keywordstyle=\color{blue},        % 关键字样式
  commentstyle=\color{dkgreen},     % 注释样式
  stringstyle=\color{mauve},        % 字符串样式
  escapeinside={\%*}{*)},           % 在代码中支持 LaTeX 命令
  morekeywords={*,...}              % 添加更多关键字
}

其中常见的选项：

除此之外，还可以定义一套新的样式（而非设置默认样式）用于指定语言，例如

1
2
3

\lstdefinestyle{cppStyle}{
    ...
}

使用例如

1
2
3
4
5
6
7
8

\begin{lstlisting}[style=cppStyle]
#include <iostream>

int main() {
    std::cout << "Hello, world!" << std::endl;
    return 0;
}
\end{lstlisting}