Latex 编写算法伪代码，基于algorithmicx包的使用说明（人工翻译自CTAN）

已于 2022-08-04 00:55:11 修改
阅读量1.5w 收藏 91
点赞数 39
分类专栏： 笔记 文章标签： 经验分享
于 2022-08-03 17:11:42 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-NC-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ambitiousssssss/article/details/126135307
版权

目录

摘要

其他布局的package

简介

算法块

简单的一行

注释

标签和引用

分解较长的算法

同一文档中使用多布局

结构化语法

for语句块

while循环

repeat语句

 if语句块

procedure语句块

function语句块

loop语句块

 输入输出语句

包选项 

给变量另起名字

示例

一份完整的伪代码

拆分算法的例子

 混合编排

References

前排提醒：

        有基础且自学很快的同学请跳转至示例与结构化语法这两部分!

mlgb，搜了一圈没啥看一眼就能用的伪代码文章。有的故事将一大堆，有的各种环境或者语法问题。自己翻译一个以后还能照着看。

algorithmic 、algorithm2e与algorithmicx的故事渊源就不再介绍，文末references中可以了解（有一些不兼容的报错得注意）

本文主要参考官方说明文档编写而成，顺序有变动：（非机翻）CTAN: Package algoridicxhttps://ctan.org/pkg/algorithmicx

摘要

        algorithmicx 包提供了许多定制的可能性算法布局。 我们可以使用其中一种预定义的布局如：pseudocode、pascal 和 c 等，可以自行修改，或者可以为特定的需求定义一个全新的布局。

使用方法：（本文以伪代码pseudocode的布局为例）

加入宏包

\usepackage{algorithm}  
\usepackage{algorithmicx}  
\usepackage{algpseudocode}

其他布局的package

        algorithmicx 本身没有定义任何算法命令，但给出了一些宏来定义这样的命令集。 可以使用
algorithmicx定义自己的命令，或者使用其中一种预定义的命令集。

常用的预定义命令集：

\usepackage<algpseudocode>
\usepackage<algcompatible>
\usepackage<algpascal>
\usepackage<algc>

第一个是伪代码命令集，随后是类似于algorithmic的命令集，pascal语言和c语言的命令集。

第二个包的原文介绍是：it is fully compatible with the algorithmic package, it should
be used only in old documents.也就是与algorithmic完全兼容的包，但一般只用于“旧文档”？？

简介

算法块

        每个算法以\begin{algorithmic}[lines]命令开始，选项[lines]控制对行标号，1代表对每行进行标号，n代表为n,2n,3n行编号，直到\end{algorithmic}命令截至。

简单的一行

        算法每行文本以\State开始，这与algorithmc包有所不同。需要指出的是，不需要在这个包的关键字前使用\State，因为这些命令会自动地启用一行。

        特别地，如果需要启用不带标号的一行，也就是承接上一行，需要使用\Statex，它会跳入新的一行，且不对新行编号。

        我们对以\State开始的行称为statements。对\Statex所在行的引用视为引用(\Statex)前一个statements所在的行号。

注释

        注释以 \Comment命令开始，在algorithmicx包中，可以任意更改注释的样式，这一点不同于algorithmic包。例如改变\algorithmiccomment 宏定义：

\algrenewcommand{\algorithmiccomment}[1]{\hskip3em$\rightarrow$ #1}

会变成：

1: x ← x + 1 → Here is the new comment

这段语法我是不大懂的，猜测是将向左的箭头⬅改成了右箭头→。\hskip是用来创建水平空间的命令。

Tex命令可参考：

hskip - Tex命令 (vue5.com)http://www.vue5.com/tex_commands/hskip.html

标签和引用

        \label命令通常用于标记所在行。当使用\ref命令对行进行引用时，它将用行号对原文进行代替。

        当algorithmicx包和algorithm包联合使用时，将能够同时标记和引用算法和所在行。\algref命令可引用给定算法的某一行。

例子：

\algref{<algorithm>}{<line>}

The \textbf{while} in algorithm
\ref{euclid} ends in line
\ref{euclidendwhile}, so
\algref{euclid}{euclidendwhile}
is the line we seek.

样式结果：

The while in algorithm 1 ends in line 7,
so 1.7 is the line we seek.

分解较长的算法

        有时候一段较长的算法需要被分成几部分描述，每一部分都是相对独立的存在(原文是separate float)。我们可以使用以下语法对algorithm进行拆分：

\algstore{<savename>} 
...
\algrestore{<savename>}

        上述语法通过自定义的savename保存算法原来的行号与所有标识。

        其中，\algstore{<savename>} 语法使用在需要保存的算法末尾之前，即在\end{algorithmc}与\end{algorithm}之前。每段被保存的算法必须有着后续！

        而后续的算法恰恰相反,\algrestore{<savename>}对具有相同<sabename>的语法段进行承接，它需要放在\begin{algorithmic}[options]这一行的后面。

        algorithmicx还提供带*号的另一种版本：

\algstore*{<savename>} 
...
\algrestore*{<savename>}

        与上面不带*有所不同，带星号的版本可选择是否恢复\algrestore*之后的部分。一下子没看懂不用着急，示例中将对这部分进行展示。

同一文档中使用多布局

        我们能在同一文件中下载多种algorithmicx下的布局宏包。\alglanguage{<layoutname>}命令能够实现不同布局之间的转换。在\alglanguage{<layoutname>}之后，将开始启用<layoutname>这种语法的环境代替之前的语法环境。

结构化语法

        如果你对algorithmic package有一定了解的话，你会发现它们之间的转换非常简单。你可以使用旧的算法描述方式加上<algorithmic>布局， 新的算法描述则需要使用<algpseudocode>布局。下面以辗转相除法求解两数的最大公约数为例给出简单的算法模板：

\begin{algorithm}
    \caption{Euclid’s algorithm}\label{euclid}
        \begin{algorithmic}[1]
\Procedure{Euclid}{$a,b$}\Comment{The g.c.d. of a and b}
    \State $r\gets a\bmod b$
\While{$r\not=0$}\Comment{We have the answer if r is 0}
    \State $a\gets b$
    \State $b\gets r$
    \State $r\gets a\bmod b$
\EndWhile\label{euclidendwhile}
    \State \textbf{return} $b$\Comment{The gcd is b}
\EndProcedure
        \end{algorithmic}
\end{algorithm}

双栏下的效果： 

        \State在每句statement的开头，标志着新的一行的开始。\Procedure...\EndProcedure与\While...\EndWhile展示了绝大部分<algpseudocode>的语法规则。每段固定句式都有着开头与结尾，中继是正文，且关键字采用驼峰命名法。

        在正确编排语法后，将自动根据缩进源进行缩进，但作者提醒大家规范的语法缩进有利于错误的查找。

        突然来了一段我没太看懂的话：

In the case of syntax descriptions the text between < and > is symbolic,so if you type what you see on the left side, you will not get the algorithm on the right side. But if you replace the text between < > with a proper piece of algorithm, then you will probably get what you want. The parts between [ and ] are optional.

        可能是想强调转义字符和原字符的输入区别？<>中间的内容原样显示。然后说[ ]中间是可选的options。

for语句块

for循环语句的几种样例如下：

\For{<text>}
    <body>
\EndFor

\ForAll{<text>}
    <body>
\EndFor

\begin{algorithmic}[1]
    \State $sum\gets 0$
\For{$i\gets 1, n$}
    \State $sum\gets sum+i$
\EndFor
\end{algorithmic}

while循环

\While{<text>}
    <body>
\EndWhile

\begin{algorithmic}[1]
    \State $sum\gets 0$
    \State $i\gets 1$
\While{$i\le n$}
    \State $sum\gets sum+i$
    \State $i\gets i+1$
\EndWhile
\end{algorithmic}

repeat语句

\Repeat
    <body>
\Until{<text>}

\begin{algorithmic}[1]
    \State $sum\gets 0$
    \State $i\gets 1$
\Repeat
    \State $sum\gets sum+i$
    \State $i\gets i+1$
\Until{$i>n$}
\end{algorithmic}

 if语句块

        得仔细看哈：

\If{<text>}
    <body>
[
  \ElsIf{<text>}
    <body>
...
]
[
  \Else
    <body>
]
\EndIf

\begin{algorithmic}[1]
\If{$quality\ge 9$}
    \State $a\gets perfect$
\ElsIf{$quality\ge 7$}
    \State $a\gets good$
\ElsIf{$quality\ge 5$}
    \State $a\gets medium$
\ElsIf{$quality\ge 3$}
    \State $a\gets bad$
\Else
    \State $a\gets unusable$
\EndIf
\end{algorithmic}

procedure语句块

\Procedure{<name>}{<params>}
    <body>
\EndProcedure

function语句块

        function语句块与上面的procedure类似：

\Function{<name>}{<params>}
    <body>
\EndFunction

loop语句块

\Loop
    <body>
\EndLoop

 输入输出语句

        算法的需求参数可以用 \Require 指令描述，结果可用\Ensure 指令描述。调用可用 \Call 指令。

\Require something
\Ensure something
    \Statex
\State \Call{Create}{10}



\begin{algorithmic}[1]
\Require $x\ge5$
\Ensure $x\le-5$
    \Statex
\While{$x>-5$}
    \State $x\gets x-1$
\EndWhile
\end{algorithmic}

        此外，可用以下语句改写成input与output的形式：

\renewcommand{\algorithmicrequire}{\textbf{Input:}}  % Use Input in the format of Algorithm  
\renewcommand{\algorithmicensure}{\textbf{Output:}} % Use Output in the format of Algorithm

包选项 

<algpseudocode> package 支持以下选项：

compatible/noncompatible：

        这个选项貌似被淘汰了，作者说如果你像使用旧的算法描述，请使用<algorithmic> package，然后使用<compatible>选项。这个选项定义了大写版本的命令，其实<algorithmic>与<algorithmicx>主要区别就是关键字的命名方法了，一个是全大写，一个是驼峰法。

        此外，作者还提醒读者需要删除注释：[...]，这大概是一些版本迭代和不兼容的原故吧。

noend/end：

        默认选项为end,意思会显示所有的end。noend则意味着文中不会出现end，作者还提醒我们没有end可能会不好看。

有无end的比照：

在这里插入图片描述

在这里插入图片描述

         网友还给出了去除如EndWhile这样单一end的方法，具体见文末第三篇参考。

给变量另起名字

        不同的人可能使用到不同的伪代码语言，所以给伪代码中的关键字另起名字就变得很重要了。

在<algpseudocode>包中，所有的关键字都以\algorithmic<keyword>的形式存在。下面列出部分修改实例：

\algrenewcommand\algorithmicwhile{\textbf{am\’\i g}}
\algrenewcommand\algorithmicdo{\textbf{v\’egezd el}}
\algrenewcommand\algorithmicend{\textbf{v\’ege}}
\begin{algorithmic}[1]
    \State $x \gets 1$
\While{$x < 10$}
    \State $x \gets x + 1$
\EndWhile
\end{algorithmic}

        在某些复杂的情况下，可能需要更多的自由更改的空间（比如上面的End与While需要对调，就是那两个看不懂的词）。有时候，命令所需要的参数可能也需要改变，这都可以通过自定义宏来完成。接下来展示一些常用的例子：

\algrenewcommand\algorithmicwhile{\textbf{am\’\i g}}
\algrenewcommand\algorithmicdo{\textbf{v\’egezd el}}
\algrenewcommand\algorithmicend{\textbf{v\’ege}}
\algrenewtext{EndWhile}{\algorithmicwhile\ \algorithmicend}
\begin{algorithmic}[1]
    \State $x \gets 1$
\While{$x < 10$}
    \State $x \gets x - 1$
\EndWhile
\end{algorithmic}

         调转了上面的End和While，得细心对比哦

\algnewcommand\algorithmicto{\textbf{to}}
\algrenewtext{For}[3]%
{\algorithmicfor\ #1 \gets #2 \algorithmicto\ #3 \algorithmicdo}
\begin{algorithmic}[1]
    \State $p \gets 1$
\For{i}{1}{n}
    \State $p \gets p * i$
\EndFor
\end{algorithmic}

         关于自定义命令的详细讲解留在下篇文章吧，这儿留个坑..文档在这个地方还介绍了pascal的算法伪代码，我就不翻译了。

示例

一份完整的伪代码

\documentclass{article}
\usepackage{algorithm}
\usepackage{algpseudocode}
\begin{document}
\begin{algorithm}
\caption{The Bellman-Kalaba algorithm}
\begin{algorithmic}[1]
\Procedure {BellmanKalaba}{$G$, $u$, $l$, $p$}
\ForAll {$v \in V(G)$}
    \State $l(v) \leftarrow \infty$
\EndFor
    \State $l(u) \leftarrow 0$
\Repeat
\For {$i \leftarrow 1, n$}
    \State $min \leftarrow l(v_i)$
\For {$j \leftarrow 1, n$}
\If {$min > e(v_i, v_j) + l(v_j)$}
    \State $min \leftarrow e(v_i, v_j) + l(v_j)$
    \State $p(i) \leftarrow v_j$
\EndIf
\EndFor
    \State $l’(i) \leftarrow min$
\EndFor
    \State $changed \leftarrow l \not= l’$
    \State $l \leftarrow l’$
\Until{$\neg changed$}
\EndProcedure
    \Statex
\Procedure {FindPathBK}{$v$, $u$, $p$}
\If {$v = u$}
    \State \textbf{Write} $v$
\Else
    \State $w \leftarrow v$
\While {$w \not= u$}
    \State \textbf{Write} $w$
    \State $w \leftarrow p(w)$
\EndWhile
\EndIf
\EndProcedure
\end{algorithmic}
\end{algorithm}
\end{document}

拆分算法的例子

\documentclass{article}
\usepackage{algorithm}
\usepackage{algpseudocode}
\begin{document}
\begin{algorithm}
\caption{Part 1}
\begin{algorithmic}[1]
\Procedure {BellmanKalaba}{$G$, $u$, $l$, $p$}
\ForAll {$v \in V(G)$}
    \State $l(v) \leftarrow \infty$
\EndFor
    \State $l(u) \leftarrow 0$
\Repeat
\For {$i \leftarrow 1, n$}
    \State $min \leftarrow l(v_i)$
\For {$j \leftarrow 1, n$}
\If {$min > e(v_i, v_j) + l(v_j)$}
    \State $min \leftarrow e(v_i, v_j) + l(v_j)$
    \State \Comment For some reason we need to break here!
\algstore{bkbreak}
\end{algorithmic}
\end{algorithm}

And we need to put some additional text between\dots

\begin{algorithm}[h]
\caption{Part 2}
\begin{algorithmic}[1]
\algrestore{bkbreak}
    \State $p(i) \leftarrow v_j$
\EndIf
\EndFor
    \State $l’(i) \leftarrow min$
\EndFor
    \State $changed \leftarrow l \not= l’$
    \State $l \leftarrow l’$
\Until{$\neg changed$}
\EndProcedure
\end{algorithmic}
\end{algorithm}
\end{document}

 混合编排

\documentclass{article}
\usepackage{algorithm}
\usepackage{algpseudocode}
\usepackage{algpascal}
\begin{document}
\alglanguage{pseudocode}
\begin{algorithm}
\caption{A small pseudocode}
\begin{algorithmic}[1]
    \State $s \gets 0$
    \State $p \gets 0$
\For{$i \gets 1,\, 10$}
    \State $s \gets s + i$
    \State $p \gets p + s$
\EndFor
\end{algorithmic}
\end{algorithm}
\alglanguage{pascal}
\begin{algorithm}
\caption{The pascal version}
\begin{algorithmic}[1]
    \State $s := 0$
    \State $p := 0$
\For{i = 1}{10}
\Begin
    \State $s := s + i$
    \State $p := p + s$
\End
\end{algorithmic}
\end{algorithm}
\end{document}

References

latex 小白 algorithmic already defined的原因 - it610.com

LaTex伪代码手册 | algorithm2e、 algorithmicx、algorithmic - 知乎 (zhihu.com)

(176条消息) latex algpseudocode 不要 end 块 | noend | no end | without end_pineappleKID的博客-CSDN博客

七月是你的谎言..
关注
  • 39
    点赞
  • 踩
  • 91
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 9
    评论
专栏目录
用latex写伪代码
11-15
Algorithm2e is an environment for writing algorithms in L ATEX2e. An algorithm is defined as a floating object like figures. It provides macros that allow you to create different sorts of key words, thus a set of predefined key words is given.
Latex 中进行算法的排版
hl156的博客
08-03 2299
在论文写作和排版过程中，常常会用到算法描述，在LaTex中，算法描述块的排版会用到两个宏包 \usepackage{algorithm} 和 \usepackage{algorithmic}。算法的排版，主要在于控制缩进、粗体、横线等格式，这些都会在这篇博客中进行介绍。
Latex写算法的伪代码排版
kt1776133839的博客
11-15 5761
algorithm2e包可能会与其它包产生冲突，一个常见的错误提示是“Too many }'...”。
Algorithmic Mathematics
11-11
Algorithmic Mathematics Stefan Hougardy Jens Vygen 使用c++11
Apriori算法伪代码
08-16
在web数据挖掘中Apriori算法的伪代码，能够很容易改成c++等语言。
Latex 算法Algorithm
weixin_30338481的博客
03-29 3194
在计算机科学当中，论文当中经常需要排版算法。相信大家在读论文中也看见了很多排版精美的算法。本文就通过示例来简要介绍一下 algorithms 束的用法。该束主要提供了两个宏包，包含两种进行算法排版的环境，algorithm 和 algorithmic 。 这两个宏包是被设计成同时一起使用的，但也可以根据用户的特殊需要分开使用。其中 algorithm 宏包主要是为算法提...
Latex——伪代码算法
yingzi的技术博客
01-27 4699
一般在论文的写作中，需要有算法流程图，现讲述两种伪代码算法流程图的实现：algorithm,algorithme2 第一个：algorithm %导包 \usepackage{algorithm} \usepackage{algorithmic} 完整代码： \documentclass{article} \usepackage{algorithm} \usepackage{algorithmic} \begin{document} \begin{algorithm} \renewcommand{
LaTeX算法排版
weixin_30437337的博客
06-13 2664
　　方式一　　 需要包含的 \usepackage[noend]{algpseudocode} \usepackage{algorithmicx,algorithm} 源码 \begin{algorithm}[t]\caption{algorithm caption}%算法的名字\hspace*{0.02in} {\bf Input:}%算...
latex 伪代码
软件工程小施同学 的专栏
10-31 3760
% 伪代码 start \usepackage{algorithm} \usepackage{algpseudocode} \usepackage{amsmath} \renewcommand{\algorithmicrequire}{\textbf{Input:}} % Use Input in the format of Algorithm \renewcommand{\algorithmicensure}{\textbf{Output:}} % Use Output i...
latex Algorithms伪代码规范
02-16
latex Algorithms伪代码规范, 详细介绍了伪代码需要调用的包，以及修改algorithms的默认设置。阐述了原理
LaTex算法库——algorithmic.sty
05-08
LaTex算法库文件——algorithm.sty，可以下载直接使用。
latex论文期刊自动排版软件使用说明文档
11-08
latex论文期刊自动排版软件使用说明文档
Latex algorithm2e 算法伪代码 官方介绍文档.pdf
12-22
latex algorithm2e 算法伪代码 官方介绍文档 latex algorithm2e 算法伪代码 官方介绍文档
Latex常用包说明.zip
01-08
Latex常用包说明.zip
使用latex编写的实验报告
最新发布
01-27
使用latex编写的编译原理的实验报告模版，分为类文件和tex文件主体两部分，类文件给定了使用的宏包和文档基本格式等，tex文件为实验报告内容，包含实验报告封面和实验内容两部分，使用了三级标题、插入图片、公式、...
Latex写伪代码
weixin_45580632的博客
03-26 248
使用Overleaf在毕业论文中插入算法伪代码，高效美观
latex 伪代码_Latex-算法伪代码
weixin_39908948的博客
12-03 2106
lalex算法伪代码请用相应的宏包!latex算法伪代码请用相应的宏包!一般来说论文中算法的伪代码生成是比较简单，所以我只给出两种方法algorithm 宏包usepackage{algorithm}usepackage{algorithmic}我给出两种例子，足够平时使用：官方用例如下：begin给出另一个我实际论文中的写法(以下算法过程，可以在我发表的论文中找到)begin{algorithm...
Latex 写算法伪代码
weixin_34061042的博客
07-04 240
LaTeX 中算法有关宏包和命令的使用• 宏包首先，需要使用以下宏包，\usepackage{algorithm}\usepackage{algorithmic}• 输入、输出和返回值此外如果算法有标准的输入和输出，以及返回值，可以使用相应的输入、输出、返回值命令，输入、输出、返回值命令依次分别为：% 该命令为输入参数说明的命令，至于命令的 "~~",具体作用也不清楚，参考的链接中是这样给的，\R...
Latex 如何使用algorithmic包书写包含各种声明(如子程序、子进程)的算法
热门推荐
NLOS的博客
09-25 1万+
问题描述 使用algorithmic包时，能够使用的声明是有限的，比如Require，Ensure等。但有时候我们可能想在算法框内书写很多没有定义的声明，如Input，Output，Procedure 1, Thread 1等等。 使用\renewcommand{\algorithmicrequire}{ \textbf{Input:}}可以强行将Require声明转换为Input:声明，但是如何在一个算法里同时使用Require，Ensure，Input，Output，Procedure 1, Thr
latex编写SMO算法伪代码
10-25
可以使用latex中的algorithm2e宏包来编写SMO算法的伪代码。下面是一个简单的例子： \begin{algorithm}[H] \SetAlgoLined \KwIn{训练数据集$D=\{(x_1,y_1),(x_2,y_2),...,(x_m,y_m)\}$，精度$\epsilon$} \KwOut{近似解$\alpha$} 初始化$\alpha=0$\; \Repeat{直到所有变量的变化量都小于$\epsilon$}{ \For{$i=1$ to $m$}{ 计算$E_i=f(x_i)-y_i$\; \If{$(y_i\cdot E_i<-tolerance\ and\ \alpha_i<C) \ or\ (y_i\cdot E_i>tolerance\ and\ \alpha_i>0)$}{ 随机选择另一个变量$j(j\neq i)$\; 计算$E_j=f(x_j)-y_j$\; 保存$\alpha_i$和$\alpha_j$\; 计算$L,H$，保证$\alpha_j$在$L$和$H$之间\; 如果$L=H$，则跳过本次循环\; 计算$\eta=2K_{ij}-K_{ii}-K_{jj}$\; \If{$\eta\geq 0$}{ 跳过本次循环\; } 更新$\alpha_j$\; 如果$|\alpha_j-\alpha_j^{old}|<\epsilon$，则跳过本次循环\; 更新$\alpha_i$\; 更新$b$\; } } } \caption{SMO算法} \end{algorithm} 其中，$f(x)$是分类器的决策函数，$K_{ij}$是核函数，$tolerance$是容错率，$C$是惩罚参数。具体实现中，需要根据具体问题进行调整和修改。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 9
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

七月是你的谎言..

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值