Latex算法包algorithm2e.sty—packageforalgorithms资源-CSDN文库

共1个文件

pdf：1个

2星需积分: 50 190 浏览量 2015-12-06 19:31:51 上传评论 1 收藏 511KB ZIP 举报

《LaTeX算法包algorithm2e.sty：打造专业算法伪代码环境》在LaTeX的世界里，编写算法伪代码是一项常见的任务，它可以帮助我们清晰地展示算法流程，为论文、教程或报告增添专业性。algorithm2e.sty是LaTeX中一个强大的算法包，专门设计用于创建高质量、可定制的算法环境。它提供了丰富的命令和选项，使得排版算法变得简单易行。 algorithm2e.sty包的核心功能在于提供了一个用户友好的框架，允许用户灵活地设定算法的样式和布局。它支持多种风格的伪代码，包括经典的控制流图（CFD）风格、Pascal风格、C风格等，可以满足不同领域的需求。此外，包内还包含了一些预定义的算法结构，如循环、条件语句、函数调用等，这些都极大地简化了算法的编写过程。使用algorithm2e.sty包，你可以轻松地创建带编号的算法，通过设置`SetAlgoNumbered`命令；或者创建不带编号的算法，只需使用`SetAlgoUnnumbered`命令。同时，包内的`SetKw`命令可以定义自定义关键字，以适应不同的编程语言特性。例如，你可以设置`SetKw{If}{if}{fi}`来创建if-then-else结构。 algorithm2e.sty也提供了对算法注释的支持，使用`\CommentSty`和`\SetKwComment`命令可以自定义注释的样式和行为。此外，包内的`DontPrintSemicolon`命令可以去除伪代码中的分号，使得代码更符合某些编程语言的习惯。在布局方面，algorithm2e.sty提供了`SetAlCapSkip`命令调整算法标题与内容之间的间距，`SetAlgoLineWidth`则可以设定算法的宽度，以适应不同的页面布局。对于多行的算法，包内的`SetInd`命令可以调整缩进，使代码更易于阅读。为了进一步增强可读性，algorithm2e.sty还支持颜色定制。通过`\SetKwInput`命令，你可以定义带颜色的关键字，比如将`Input`和`Output`设置为不同的颜色。同时，`SetFillin`命令允许用户设置填充色，为特定的算法元素添加背景色。在压缩包中，algorithm2e.pdf文档详细地介绍了这个包的所有功能和使用方法，包括各种命令、选项和示例。通过深入阅读这份文档，用户可以全面了解如何利用algorithm2e.sty来实现个性化的算法展示。 algorithm2e.sty是LaTeX用户编写算法伪代码的理想选择。无论你是初次接触还是资深用户，都能通过它的强大功能和灵活配置，快速制作出专业且美观的算法描述。在学术研究、教学或软件开发中，它都能帮助你提升文档的质量，让算法部分更加醒目、易懂。因此，熟练掌握algorithm2e.sty的使用，无疑是提高LaTeX排版效率的重要一步。

资源推荐

资源详情

资源评论

收起资源包目录

algorithm2e.zip （1个子文件）

algorithm2e.pdf 529KB

algorithm2e.sty — package for algorithms

release 5.1

Report bugs and comments to cﬁorio@umontpellier.fr

algorithm2esty-annonce@lirmm.fr mailing list for announcements

algorithm2esty-discussion@lirmm.fr mailing list for discussion

∗†‡§¶k∗∗††

October 19 2015

Contents

1 Introduction 3

2 How to use it: abstract 3

3 Two more detailed examples 4

3.1 Algorithm disjoint decomposition . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

3.2 Algorithm: IntervalRestriction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

4 Genericity and example of languages 8

5 Compatibility issues 12

6 Environments deﬁned in the package 17

7 The options of the package 18

7.1 language option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

7.2 compatibility issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

7.3 environment display and use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

7.3.1 boxed, ruled, plain environment . . . . . . . . . . . . . . . . . . . . . . . . . 19

7.3.2 algorithm numbering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

7.3.3 ﬁgure and toc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

7.4 code typesetting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

7.4.1 indentation of long statements . . . . . . . . . . . . . . . . . . . . . . . . . 20

7.4.2 blocks display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

7.4.3 end keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

7.4.4 comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

7.4.5 lines numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

7.4.6 title of algorithms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

∗

The author is very grateful to David Carlisle, one of the authors of the LaTeX Companion book, for his advices

†

Martin Blais for his suggestions

‡

David A. Bader for his new option noend

Gilles Geeraerts for his new command SetKwIfElseIf

Ricardo Fukasawa for the portuguese keywords

Christian Icking for the german translation of keywords

∗∗

Arnaud Giersch for his suggestions and corrections on SetKwComments

††

and the many users as Jean-Baptiste Rouquier for their remarks

8 Typesetting 21

9 Commands provided with the package 22

9.1 global code typesetting commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

9.2 algorithm environment, caption, list of algorithms, ... . . . . . . . . . . . . . . . . . 22

9.2.1 caption, title and changind reference of algorithms . . . . . . . . . . . . . . 22

9.2.2 setting style and layout of algorithm, caption and title . . . . . . . . . . . . 23

9.3 line numbering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

9.3.1 labelling and numbering lines . . . . . . . . . . . . . . . . . . . . . . . . . . 24

9.3.2 setting style of lines numbers . . . . . . . . . . . . . . . . . . . . . . . . . . 24

9.4 math display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

9.5 standard styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

9.5.1 standard font shapes and styles . . . . . . . . . . . . . . . . . . . . . . . . . 25

9.5.2 caption and title font style . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

9.5.3 setting font standard font shapes and styles . . . . . . . . . . . . . . . . . . 27

9.5.4 setting caption and title font style . . . . . . . . . . . . . . . . . . . . . . . 28

9.6 controlling the layout of algorithms . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

9.7 comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

10 The predeﬁned language keywords 31

10.1 Input, output macros... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

10.2 basic keywords and blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

10.3 comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

10.4 if-then-else macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

10.5 multiple condition selection: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

10.6 loops with ”end condition” test at the beginning . . . . . . . . . . . . . . . . . . . 33

10.7 loops with ”end condition” test at the end . . . . . . . . . . . . . . . . . . . . . . . 34

10.8 how default keywords are obtained . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

11 To deﬁne your own language keywords 35

11.1 to deﬁne Input, output macros... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

11.2 to deﬁne basic keywords or blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

11.3 to deﬁne keywords as function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

11.4 to deﬁne comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

11.5 to deﬁne if-then-else macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

11.6 to deﬁne multiple condition selection: . . . . . . . . . . . . . . . . . . . . . . . . . 39

11.7 to deﬁne loops with ”end condition” test at the beginning . . . . . . . . . . . . . . 40

11.8 to deﬁne loops with ”end condition” test at the end . . . . . . . . . . . . . . . . . 41

12 Other language predeﬁned keywords 41

12.1 French keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

12.2 German keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

12.3 Spanish keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

12.4 Italian keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

12.5 Portuguese keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

12.6 Some Czech keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

13 Known bugs 49

1 Introduction

Algorithm2e is an environment for writing algorithms in L

X2e. An algorithm is deﬁned as a

ﬂoating object like ﬁgures. It provides macros that allow you to create diﬀerent sorts of key words,

thus a set of predeﬁned key words is given. You can also change the typography of the keywords.

See section 3 for two long examples of algorithms written with this package.

You can subscribe to algorithm2e-announce mailing list to receive announcements about

revisions of the package and to algorithm2e-discussion to discuss, send comments, ask questions

about the package. In order to subscribe to the mailing lists you have to send an email to

sympa@lirmm.fr with subscribe algorithm2e-announce Firstname Name or

subscribe algorithm2e-discussion Firstname Name in the body of the message.

Changes from one release to the next are indicated in release notes at the beginning of the

packages. For this release (5.0), changes are indicated at the end of this document.

2 How to use it: abstract

You must set \usepackage[options ]{algorithm2e} before \begin{document} command. The

available options are described in section 7.

The optional arguments [Hhtbp] works like those of ﬁgure environment. The H argument

forces the algorithm to stay in place. If used, an algorithm is no more a ﬂoating object. Caution:

algorithms cannot be cut, so if there is not enough place to put an algorithm with H option at a

given spot, L

X will place a blank and put the algorithm on the following page.

Here is a quick example

\begin{algorithm}[H]

\SetAlgoLined

\KwData{this text}

\KwResult{how to write algorithm with \LaTeX2e }

initialization\;

\While{not at end of this document}{

read current\;

\eIf{understand}{

go to next section\;

current section becomes this one\;

}{

go back to the beginning of current section\;

}

\caption{How to write algorithms}

\end{algorithm}

For longer and more complexe examples see section 3

which gives

Data: this text

Result: how to write algorithm with L

X2e

initialization;

while not at end of this document do

read current section;

if understand then

go to next section;

current section becomes this one;

else

go back to the beginning of current section;

end

Algorithm 1: How to write algorithms

Very Important : each line MUST end with \; only those with a macro beginning a block

should not end with \;. Note then that you can always use the \; command in math mode to set

a small space.

The caption works as in a ﬁgure environment, except that it should be located at the end of

the algorithm. It is used by \listofalgorithms as a reference name for the list of algorithms.

You can also use the title macro given with the package, but this macro doesn’t insert an entry

in the list of algorithms.

3 Two more detailed examples

The algorithm 2 and algorithm 3 are written with this package.

3.1 Algorithm disjoint decomposition

Here we suppose that we have done:

\usepackage[linesnumbered,lined,boxed,commentsnumbered]{algorithm2e}

The algorithm 2 was written in L

X2e code as presented next page. You can label lines, and for

example line 4 denotes the second For (see \label command in the example). Notice also some

ways of doing comments at lines 8, 12, 14 and 16. Star comment commands are for comment on

lines of code, else comment is a line by itself as at line 14. The diﬀerent option in star comments

deﬁnes if it is left (l and h) or right justiﬁed (r and f). The ﬁrst ones (l and r) add ; at the end

of line code, the second ones (f and h) doesn’t. These last are useful when used in side comment

(introduced by ()) of alternatives of loops keyword commands.

input : A bitmap Im of size w × l

output: A partition of the bitmap

1 special treatment of the ﬁrst line;

2 for i ← 2 to l do

3 special treatment of the ﬁrst element of line i;

4 for j ← 2 to w do

5 left ← FindCompress(Im[i, j − 1]);

6 up ← FindCompress(Im[i − 1, ]);

7 this ← FindCompress(Im[i, j]);

8 if left compatible with this then // O(left,this)==1

9 if left < this then Union(left,this);

10 else Union(this,left);

11 end

12 if up compatible with this then // O(up,this)==1

13 if up < this then Union(up,this);

14 // this is put under up to keep tree as flat as possible

15 else Union(this,up);

16 // this linked to up

17 end

18 end

19 foreach element e of the line i do FindCompress(p);

20 end

Algorithm 2: disjoint decomposition

\IncMargin{1em}

\begin{algorithm}

\SetKwData{Left}{left}\SetKwData{This}{this}\SetKwData{Up}{up}

\SetKwFunction{Union}{Union}\SetKwFunction{FindCompress}{FindCompress}

\SetKwInOut{Input}{input}\SetKwInOut{Output}{output}

\Input{A bitmap $Im$ of size $w\times l$}

\Output{A partition of the bitmap}

\BlankLine

\emph{special treatment of the first line}\;

\For{$i\leftarrow 2$ \KwTo $l$}{

\emph{special treatment of the first element of line $i$}\;

\For{$j\leftarrow 2$ \KwTo $w$}{\label{forins}

\Left$\leftarrow$ \FindCompress{$Im[i,j-1]$}\;

\Up$\leftarrow$ \FindCompress{$Im[i-1,]$}\;

\This$\leftarrow$ \FindCompress{$Im[i,j]$}\;

\If(\tcp*[h]{O(\Left,\This)==1}){\Left compatible with \This}{\label{lt}

\lIf{\Left $<$ \This}{\Union{\Left,\This}}

\lElse{\Union{\This,\Left}}

}

\If(\tcp*[f]{O(\Up,\This)==1}){\Up compatible with \This}{\label{ut}

\lIf{\Up $<$ \This}{\Union{\Up,\This}}

\tcp{\This is put under \Up to keep tree as flat as possible}\label{cmt}

\lElse{\Union{\This,\Up}}\tcp*[h]{\This linked to \Up}\label{lelse}

}

\lForEach{element $e$ of the line $i$}{\FindCompress{p}}

}

\caption{disjoint decomposition}\label{algo_disjdecomp}

\end{algorithm}\DecMargin{1em}

评论收藏

内容反馈

yangxi_940123

2016-01-27

为啥是pdf啊，说好的.sty安装包捏？
warren1800010696

2023-06-21

#毫无价值只有pdf。后面我在bing上面搜到了，想找.sty的可以在官网下载（网址https://www.ctan.org/pkg/algorithm2e）
安静_xju

2019-03-12

靠，坑逼，坑逼
修改昵称呀

2017-03-17

这个真心是只有PDF，下载之前看评论呀！
gudian1618

2016-10-12

啊，被坑了