diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/algorithmicx')
| -rw-r--r-- | Master/texmf-dist/doc/latex/algorithmicx/README | 4 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/algorithmicx/algorithmicx.pdf | bin | 201459 -> 196147 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/algorithmicx/algorithmicx.tex | 615 |
3 files changed, 391 insertions, 228 deletions
diff --git a/Master/texmf-dist/doc/latex/algorithmicx/README b/Master/texmf-dist/doc/latex/algorithmicx/README new file mode 100644 index 00000000000..97b93dc13cd --- /dev/null +++ b/Master/texmf-dist/doc/latex/algorithmicx/README @@ -0,0 +1,4 @@ +This package provides many possibilities to customize the layout of algorithms. +You can use one of the predefined layouts (pseudocode, pascal, +c, and others), with or without modifications, or you can define a +completely new layout for your specific needs.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/algorithmicx/algorithmicx.pdf b/Master/texmf-dist/doc/latex/algorithmicx/algorithmicx.pdf Binary files differindex 9e837c377c0..a142d0135f8 100644 --- a/Master/texmf-dist/doc/latex/algorithmicx/algorithmicx.pdf +++ b/Master/texmf-dist/doc/latex/algorithmicx/algorithmicx.pdf diff --git a/Master/texmf-dist/doc/latex/algorithmicx/algorithmicx.tex b/Master/texmf-dist/doc/latex/algorithmicx/algorithmicx.tex index c04febbb9e1..a92c017f7ae 100644 --- a/Master/texmf-dist/doc/latex/algorithmicx/algorithmicx.tex +++ b/Master/texmf-dist/doc/latex/algorithmicx/algorithmicx.tex @@ -1,25 +1,23 @@ \documentclass{article} \usepackage{algorithmicx} \usepackage[ruled]{algorithm} -\usepackage[noset]{algpseudocode} -\usepackage[noset]{algpascal} -\usepackage[noset]{algc} - +\usepackage{algpseudocode} +\usepackage{algpascal} +\usepackage{algc} +%\algdisablelines \newcommand{\alg}{\texttt{algorithmicx}} \newcommand{\old}{\texttt{algorithmic}} \newcommand{\euk}{Euclid} -\newenvironment{alginc}[1][pseudocode]{\medskip\algsetlanguage{#1}\begin{algorithmic}[1]}{\end{algorithmic}\medskip} -\newenvironment{algi}[1][pseudocode]{\algsetlanguage{#1}\begin{algorithmic}[1]}{\end{algorithmic}} -\newcommand\ASTART{\bigskip\noindent\begin{minipage}[c]{0.5\linewidth}} -\newcommand\ACONTINUE{\end{minipage}\begin{minipage}[c]{0.5\linewidth}} +\newcommand\ASTART{\bigskip\noindent\begin{minipage}[b]{0.5\linewidth}} +\newcommand\ACONTINUE{\end{minipage}\begin{minipage}[b]{0.5\linewidth}} \newcommand\AENDSKIP{\end{minipage}\bigskip} \newcommand\AEND{\end{minipage}} -\title{The \alg\ package\footnote{This is the documentation for the version 1.1 +\title{The \alg\ package\footnote{This is the documentation for the version 1.2 of the package. This package is released under LPPL.}} \author{Sz\'asz J\'anos\\szaszjanos@users.sourceforge.net} @@ -39,12 +37,12 @@ completely new layout for your specific needs. \section{Introduction} -All this begun in my last year at the university. The only thing that I knew of +All this has begun in my last year at the university. The only thing that I knew of \LaTeX\ was that it exists, and that it is ``good''. I started using it, but I needed to typeset some -algorithms. So I begun searching for a good algorithmic style, and I found the \old\ package. +algorithms. So I begun searching for a good algorithmic style, and I have found the \old\ package. It was a great joy for me, and I started to use it\dots\ Well\dots\ Everything went nice, until I needed some block that wasn't defined in there. What to do? -I wasn't a \LaTeX\ guru, in fact I only knew the few basic macros. But there was no other way, so I opened +I was no \LaTeX\ guru, in fact I only knew the few basic macros. But there was no other way, so I opened the style file, and I copied one existing block, renamed a few things, and voil\`a! This (and some other small changes) where enough for me\dots @@ -52,7 +50,7 @@ One year later --- for one good soul --- I had to make some really big changes o a sunny day came the idea. What if I would write some macros to let others create blocks automatically? And so I did! Since then the style was completely rewritten\dots\ several times\dots -I had fun writing it, may you have fun using it! I am still not a \LaTeX\ guru, so if you are, and you find +I had fun writing it, may you have fun using it! I am still no \LaTeX\ guru, so if you are, and you find something really ugly in the style, please mail me! All ideas for improvements are welcome! Thanks go to Benedek Zsuzsa, Ionescu Clara, Sz\H ocs Zolt\'an, Cseke Botond, Kanoc @@ -62,73 +60,81 @@ and many-many others. Without them I would have never started or continued \text -\section{The predefined layouts} +\section{General informations} + +\subsection{The package} The package \textbf{algorithmicx} itself doesn't define any algorithmic commands, but gives -a set of macros to define such a command set. So you may use \textbf{algorithmicx}, and define -the commands yourself, or use one of the predefined command sets. +a set of macros to define such a command set. You may use only \textbf{algorithmicx}, and define +the commands yourself, or you may use one of the predefined command sets. -The following predefined command sets (layouts) are available: +These predefined command sets (layouts) are: \begin{description} \item[algpseudocode] has the same look\footnote{almost :-)} as the one defined in the \old\ package. The main difference is that while the \old\ package doesn't allow you to modify predefined structures, or to create new ones, the \alg\ package gives you full control over the definitions (ok, there are some limitations --- you can not send mail with a, say, \verb:\For: command). +\item[algcompatible] is fully compatible with the \old\ package, it should be +used only in old documents. \item[algpascal] aims to create a formatted pascal program, it performs automatic indentation (!), so you can transform a pascal program into an \textbf{algpascal} algorithm description with some basic substitution rules. -\item[algc] yeah, just like the \textbf{algpascal}\dots\ but for C\dots\ +\item[algc] -- yeah, just like the \textbf{algpascal}\dots\ but for c\dots\ This layout is incomplete. \end{description} +To create floating algorithms you will need \verb:algorithm.sty:. This file may or may not be +included in the \alg\ package. You can find it on CTAN, in the \old\ package. + -\subsection{General informations} +\subsection{The algorithmic block} Each algorithm begins with the \verb:\begin{algorithmic}[lines]: command, the optional \verb:lines: controls the line numbering: $0$ means no line numbering, $1$ means number every line, and $n$ means number lines $n$, $2n$, $3n$\dots\ until the -\verb:\end{algorithmic}: command, which ends the algorithm. +\verb:\end{algorithmic}: command, witch ends the algorithm. -\subsubsection{Simple lines} -A simple line of text begins with \verb:\State:. This macro marks the begining of every + +\subsection{Simple lines} + +A simple line of text is beginned with \verb:\State:. This macro marks the begin of every line. You don't need to use \verb:\State: before a command defined in the package, since these commands use automatically a new line. -To create a line that is not numbered, and not counted when numbering lines +To obtain a line that is not numbered, and not counted when counting the lines for line numbering (in case you choose to number lines), use the \verb:Statex: macro. This macro jumps into a new line, the line gets no number, and any label will point to the previous numbered line. -We will call \textit{statement\/}s the lines starting with \verb:\State:. The \verb:\Statex: -lines are not statements. +We will call \textit{statament\/}s the lines starting with \verb:\State:. The \verb:\Statex: +lines are not stataments. -\subsubsection{Placing comments in sources}\label{Putting comments in sources} +\subsection{Placing comments in sources}\label{Putting comments in sources} Comments may be placed everywhere in the source using the \verb:\Comment: macro -(there are no limitations like those in the \old\ package), so feel the freedom! -If you would like to change the form in which comments are displayed, just +(there are no limitations like those in the \old\ package), feel the freedom! +If you would like to change the form in witch comments are displayed, just change the \verb:\algorithmiccomment: macro: \begin{verbatim} -\renewcommand{\algorithmiccomment}[1]{\hskip 3em$\rightarrow$ #1} +\algrenewcommand{\algorithmiccomment}[1]{\hskip3em$\rightarrow$ #1} \end{verbatim} will result: -{ -\begin{alginc} -\renewcommand{\algorithmiccomment}[1]{\hskip 3em$\rightarrow$ #1} +\medskip +\begin{algorithmic}[1] +\algrenewcommand{\algorithmiccomment}[1]{\hskip3em$\rightarrow$ #1} \State $x\gets x+1$\Comment{Here is the new comment} -\end{alginc} -} +\end{algorithmic} -\subsubsection{Labels and references} -Use the \verb:\label: macro, as usual, to label a line. When you use \verb:\ref: to reference -the line, the \verb:\ref: will be substituted with the corresponding line number. When using the -\textbf{algorithmicx} package together with the \textbf{algorithm} package, then you can label +\subsection{Labels and references} +Use the \verb:\label: macro, as usual to label a line. When you use \verb:\ref: to reference +the line, the \verb:\ref: will be subtitued with the corresponding line number. When using the +\textbf{algorithmicx} package togedher with the \textbf{algorithm} package, then you can label both the algorithm and the line, and use the \verb:\algref: macro to reference a given line from a given algorithm: @@ -149,15 +155,42 @@ The \textbf{while} in algorithm \ref{euclid} ends in line \ref{euclidendwhile}, so \algref{euclid}{euclidendwhile} is the line we seek. \end{minipage} +\subsection{Breaking up long algorithms} + +Sometimes you have a long algorithm that needs to be broken into parts, each on a +separate float. For this you can use the following: + +\begin{description} +\item[]\verb:\algstore{<savename>}: saves the line number, indentation, open blocks of +the current algorithm and closes all blocks. If used, then this must be the last command +before closing the algorithmic block. Each saved algorithm must be continued later in the +document. +\item[]\verb:\algstore*{<savename>}: Like the above, but the algorithm must not be continued. +\item[]\verb:\algrestore{<savename>}: restores the state of the algorithm saved under +\verb:<savename>: in this algorithmic block. If used, then this must be the first command +in an algorithmic block. A save is deleted while restoring. +\item[]\verb:\algrestore*{<savename>}: Like the above, but the save will not be deleted, so it +can be restored again. +\end{description} + +See example in the \textbf{Examples} section. +\subsection{Multiple layouts in the same document} +You can load multiple algorithmicx layouts in the same document. You can switch between the layouts +using the \verb:\alglanguage{<layoutname>}: command. After this command all new algorithmic +environments will use the given layout until the layout is changed again. + + + + +\section{The predefined layouts} \subsection{The \textbf{algpseudocode} layout}\label{algpseudocode} +\alglanguage{pseudocode} If you are familiar with the \old\ package, then you'll find it easy to -switch, and you have good chances to use previously written algorithms -without changing them (some comments needs to be placed to their right -place, but you will be happy to have them there). You only need to read the -section \ref{Putting comments in sources} and \ref{algpseudocode package options}. +switch. You can use the old algorithms with the \textbf{algcompatible} layout, but please +use the \textbf{algpseudocode} layout for new algorithms. To use \textbf{algpseudocode}, simply load \verb:algpseudocode.sty:: @@ -168,11 +201,12 @@ To use \textbf{algpseudocode}, simply load \verb:algpseudocode.sty:: You don't need to manually load the \textbf{algorithmicx} package, as this is done by \textbf{algpseudocode}. -Let's see for example the well known \textit{\euk's algorithm} (ok, an improved version): -{ +The first algorithm one should write is the first algorithm ever (ok, +an improved version), \textit{\euk's algorithm}: + \begin{algorithm}[H] \caption{\euk's algorithm}\label{euclid} -\begin{alginc} +\begin{algorithmic}[1] \Procedure{\euk}{$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} @@ -180,11 +214,11 @@ Let's see for example the well known \textit{\euk's algorithm} (ok, an improved \State $b\gets r$ \State $r\gets a\bmod b$ \EndWhile\label{euclidendwhile} - \State \Return $b$\Comment{The g.c.d. is b} + \State \Return $b$\Comment{The gcd is b} \EndProcedure -\end{alginc} +\end{algorithmic} \end{algorithm} -} + Created with the following source: \begin{verbatim} @@ -198,7 +232,7 @@ Created with the following source: \State $b\gets r$ \State $r\gets a\bmod b$ \EndWhile\label{euclidendwhile} - \State \textbf{return} $b$\Comment{The g.c.d. is b} + \State \textbf{return} $b$\Comment{The gcd is b} \EndProcedure \end{algorithmic} \end{algorithm} @@ -220,13 +254,12 @@ The indentation of the source doesn't matter, so \end{algorithmic} \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \Repeat \Comment{forever} \State this\Until{you die.} -\end{algi} -} +\Statex +\end{algorithmic} \AENDSKIP But, generally, it is a good idea to keep the source indented, since you will find @@ -235,20 +268,20 @@ errors much easier. And your tex file looks better! All examples and syntax descriptions will be shown as the previous example --- the left side shows the \LaTeX\ input, and the right side the algorithm, as it appears in your document. I'm cheating! Don't look -in the \verb:tex: file! Believe what the examples state! I'm using some -undocumented and dirty stuff to create all these examples. You may be more +in the \verb:algorithmicx.tex: file! Believe what the examples state! I may use some +undocumented and dirty stuff to create all these examples. You might be more confused after opening \verb:algorithmicx.tex: as you was before. In the case of syntax -descriptions the text between "$<$" and "$>$" is symbolic, so if you type +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 enclosed between "$<$" and "$>$" with a proper piece of -algorithm, then you will get what you probably want. The parts between -"$[$" and "$]$" are optional. +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. \subsubsection{The \textbf{for} block} -The \textbf{for} block has the following syntax: +The \textbf{for} block may have one of the forms: \ASTART \begin{verbatim} @@ -257,13 +290,11 @@ The \textbf{for} block has the following syntax: \EndFor \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \For{$<$text$>$} \State $<$body$>$ \EndFor -\end{algi} -} +\end{algorithmic} \AEND \ASTART @@ -273,12 +304,11 @@ The \textbf{for} block has the following syntax: \EndFor \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \ForAll{$<$text$>$} \State $<$body$>$ \EndFor -\end{algi}} +\end{algorithmic} \AENDSKIP \noindent Example: @@ -293,14 +323,13 @@ The \textbf{for} block has the following syntax: \end{algorithmic} \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \State $sum\gets 0$ \For{$i\gets 1, n$} \State $sum\gets sum+i$ \EndFor -\end{algi} -} +\Statex +\end{algorithmic} \AEND \subsubsection{The \textbf{while} block} @@ -313,13 +342,11 @@ The \textbf{while} block has the form: \EndWhile \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \While{$<$text$>$} \State $<$body$>$ \EndWhile -\end{algi} -} +\end{algorithmic} \AENDSKIP \noindent Example: @@ -336,8 +363,6 @@ The \textbf{while} block has the form: \end{algorithmic} \end{verbatim} \ACONTINUE -{ -\algsetlanguage{pseudocode} \begin{algorithmic}[1] \State $sum\gets 0$ \State $i\gets 1$ @@ -345,8 +370,8 @@ The \textbf{while} block has the form: \State $sum\gets sum+i$ \State $i\gets i+1$ \EndWhile +\Statex \end{algorithmic} -} \AEND \subsubsection{The \textbf{repeat} block} @@ -359,13 +384,11 @@ The \textbf{repeat} block has the form: \Until{<text>} \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \Repeat \State $<$body$>$ \Until{$<$text$>$} -\end{algi} -} +\end{algorithmic} \AENDSKIP \noindent Example: @@ -382,16 +405,15 @@ The \textbf{repeat} block has the form: \end{algorithmic} \end{verbatim} \ACONTINUE -{ -\begin{algi} +\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{algi} -} +\Statex +\end{algorithmic} \AEND \subsubsection{The \textbf{if} block} @@ -413,22 +435,20 @@ The \textbf{if} block has the form: \EndIf \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \If{$<$text$>$} \State $<$body$>$ -\Statex \hskip-2\algorithmicindent[ +\Statex [ \ElsIf{$<$text$>$} \State $<$body$>$ -\Statex \hskip-2\algorithmicindent... -\Statex \hskip-2\algorithmicindent] -\Statex \hskip-2\algorithmicindent[ +\Statex \dots +\Statex ] +\Statex [ \Else \State $<$body$>$ -\Statex \hskip-2\algorithmicindent] +\Statex ] \EndIf -\end{algi} -} +\end{algorithmic} \AENDSKIP \noindent Example: @@ -450,8 +470,7 @@ The \textbf{if} block has the form: \end{algorithmic} \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \If{$quality\ge 9$} \State $a\gets perfect$ \ElsIf{$quality\ge 7$} @@ -463,8 +482,8 @@ The \textbf{if} block has the form: \Else \State $a\gets unusable$ \EndIf -\end{algi} -} +\Statex +\end{algorithmic} \AEND \subsubsection{The \textbf{procedure} block} @@ -477,13 +496,11 @@ The \textbf{procedure} block has the form: \EndProcedure \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \Procedure{$<$name$>$}{$<$params$>$} \State $<$body$>$ \EndProcedure -\end{algi} -} +\end{algorithmic} \AENDSKIP \noindent Example: See \euk's\ algorithm on page \pageref{euclid}. @@ -498,13 +515,11 @@ The \textbf{procedure} block has the form: \EndFunction \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \Function{$<$name$>$}{$<$params$>$} \State $<$body$>$ \EndFunction -\end{algi} -} +\end{algorithmic} \AEND \subsubsection{The \textbf{loop} block} @@ -517,32 +532,34 @@ The \textbf{loop} block has the form: \EndLoop \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \Loop \State $<$body$>$ \EndLoop -\end{algi} -} +\end{algorithmic} \AEND -\subsubsection{\textbf{Require} and \textbf{Ensure}} +\subsubsection{Other commands in this layout} The starting conditions for the algorithm can be described with the \textbf{require} -instruction, and its result with the \textbf{ensure} instruction.: +instruction, and its result with the \textbf{ensure} instruction. + +A procedure call can be formatted with \verb:\Call:. \ASTART \begin{verbatim} \Require something \Ensure something +\Statex +\State \Call{Create}{10} \end{verbatim} \ACONTINUE -{ -\begin{algi} +\begin{algorithmic}[1] \Require something \Ensure something -\end{algi} -} +\Statex +\State \Call{Create}{10} +\end{algorithmic} \AENDSKIP \noindent Example: @@ -559,16 +576,15 @@ instruction, and its result with the \textbf{ensure} instruction.: \end{algorithmic} \end{verbatim} \ACONTINUE -{ -\begin{alginc} +\begin{algorithmic}[1] \Require $x\ge5$ \Ensure $x\le-5$ \Statex \While{$x>-5$} \State $x\gets x-1$ \EndWhile -\end{alginc} -} +\Statex +\end{algorithmic} \AEND @@ -580,7 +596,8 @@ instruction, and its result with the \textbf{ensure} instruction.: The \texttt{algpseudocode} package supports the following options: \begin{description} -\item[compatible/noncompatible]\ \\If you would like to use old +\item[compatible/noncompatible]\ \textit{Obsolote, use the algcompatible layout instead.}\\ +If you would like to use old algorithms, written with the \old\ package without (too much) modification, then use the \textbf{compatible} option. This option defines the uppercase version of the commands. Note that you still need @@ -589,7 +606,7 @@ limitations in the \old\ package, these limitations and comments are gone now). The default \textbf{noncompatible} does not define the all uppercase commands. \item[noend/end]\ \\With \textbf{noend} specified all \textbf{end \dots} -lines are omitted. You get a somewhat smaller algorithm, and the odd +lines are omitted. You get a somewhat smaller algorithm, and the ugly feeling, that something is missing\dots{} The \textbf{end} value is the default, it means, that all \textbf{end \dots} lines are in their right place. @@ -600,48 +617,45 @@ place. One common thing for a pseudocode is to change the command names. Many people use many different kind of pseudocode command names. In \textbf{algpseudocode} all keywords are declared as \verb:\algorithmic<keyword>:. You can change them -to output the text you need. For example, to obtain a hungarian translation, you write: +to output the text you need: \bigskip\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} -\renewcommand\algorithmicwhile{\textbf{am\'\i g}} -\renewcommand\algorithmicdo{\textbf{ism\'eteld}} -\renewcommand\algorithmicend{\textbf{v\'ege}} +\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$ + \State $x \gets x + 1$ \EndWhile \end{algorithmic} \end{verbatim} \end{minipage} \begin{minipage}[b]{0.5\linewidth} -{ -\algsetlanguage{pseudocode} \begin{algorithmic}[1] -\renewcommand\algorithmicwhile{\textbf{am\'\i g}} -\renewcommand\algorithmicdo{\textbf{ism\'eteld}} -\renewcommand\algorithmicend{\textbf{v\'ege}} +\algrenewcommand\algorithmicwhile{\textbf{am\'\i g}} +\algrenewcommand\algorithmicdo{\textbf{v\'egezd el}} +\algrenewcommand\algorithmicend{\textbf{v\'ege}} \State $x \gets 1$ \While{$x < 10$} - \State $x \gets x - 1$ + \State $x \gets x + 1$ \EndWhile \Statex \end{algorithmic} -} \end{minipage}\bigskip In some cases you may need to change even more (in the above example \textbf{am\'\i g} and \textbf{v\'ege} should be interchanged in the \verb:\EndWhile: text). Maybe the number of the parameters taken by some commands must be changed too. -This can be done with the command text customizing macros (see section +this can be done with the command text customizing macros (see section \ref{custom text}). Here I'll give only some examples of the most common usage: \bigskip\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} -\renewcommand\algorithmicwhile{\textbf{am\'\i g}} -\renewcommand\algorithmicdo{\textbf{ism\'eteld}} -\renewcommand\algorithmicend{\textbf{v\'ege}} +\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$ @@ -652,12 +666,10 @@ This can be done with the command text customizing macros (see section \end{verbatim} \end{minipage} \begin{minipage}[b]{0.5\linewidth} -{ -\algsetlanguage{pseudocode} \begin{algorithmic}[1] -\renewcommand\algorithmicwhile{\textbf{am\'\i g}} -\renewcommand\algorithmicdo{\textbf{ism\'eteld}} -\renewcommand\algorithmicend{\textbf{v\'ege}} +\algrenewcommand\algorithmicwhile{\textbf{am\'\i g}} +\algrenewcommand\algorithmicdo{\textbf{v\'egezd el}} +\algrenewcommand\algorithmicend{\textbf{v\'ege}} \algrenewtext{EndWhile}{\algorithmicwhile\ \algorithmicend} \State $x \gets 1$ \While{$x < 10$} @@ -665,12 +677,11 @@ This can be done with the command text customizing macros (see section \EndWhile \Statex \end{algorithmic} -} \end{minipage} \bigskip\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} -\newcommand\algorithmicto{\textbf{to}} +\algnewcommand\algorithmicto{\textbf{to}} \algrenewtext{For}[3]% {\algorithmicfor\ #1 \gets #2 \algorithmicto\ #3 \algorithmicdo} \begin{algorithmic}[1] @@ -682,10 +693,8 @@ This can be done with the command text customizing macros (see section \end{verbatim} \end{minipage} \begin{minipage}[b]{0.5\linewidth} -{ -\algsetlanguage{pseudocode} \begin{algorithmic}[1] -\newcommand\algorithmicto{\textbf{to}} +\algnewcommand\algorithmicto{\textbf{to}} \algrenewtext{For}[3]% {\algorithmicfor\ $#1 \gets #2$ \algorithmicto\ $#3$ \algorithmicdo} \State $p \gets 1$ @@ -694,10 +703,9 @@ This can be done with the command text customizing macros (see section \EndFor \Statex \end{algorithmic} -} \end{minipage}\bigskip -You might want to create translation packages, which included after the \textbf{algpseudocode} +You could create a translation package, that included after the \textbf{algpseudocode} package translates the keywords to the language you need. @@ -705,12 +713,12 @@ package translates the keywords to the language you need. \subsection{The \textbf{algpascal} layout} +\alglanguage{pascal} - -The most important features of the \textbf{algpascal} layout is that -\textit{it performs automatically the end-of-block indentation}. In +The most important feature of the \textbf{algpascal} layout is that +\textit{it performs automatically the block indentation}. In section \ref{algorithmicx} you will see how to define such automatically indented loops. Here is an example to demonstrate this feature: @@ -720,23 +728,22 @@ feature: \begin{algorithmic}[1] \Begin \State $sum:=0$; -\For{i=1}{n} +\For{i=1}{n}\Comment{sum(i)} \State $sum:=sum+i$; \State writeln($sum$); \End. \end{algorithmic} \end{verbatim} \ACONTINUE -{ -\begin{algi}[pascal] +\begin{algorithmic}[1] \Begin \State $sum:=0$; -\For{i=1}{n} +\For{i=1}{n}\Comment{sum(i)} \State $sum:=sum+i$; \State writeln($sum$); \End. -\end{algi} -} +\Statex +\end{algorithmic} \AENDSKIP Note, that the \verb:\For: is not closed explicitly, its end is @@ -747,20 +754,18 @@ mathematical mode. \subsubsection{The \textbf{begin} \dots{} \textbf{end} block} -\noindent\begin{minipage}[c]{0.5\linewidth} +\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} \Begin <body> \End \end{verbatim} \ACONTINUE -{ -\begin{algi}[pascal] +\begin{algorithmic}[1] \Begin \State $<$body$>$ \End -\end{algi} -} +\end{algorithmic} \AENDSKIP The \verb:\Begin: \dots{} \verb:\End: block and the @@ -773,18 +778,16 @@ after the following command (another loop, or a block). \subsubsection{The \textbf{for} loop} -\noindent\begin{minipage}[c]{0.5\linewidth} +\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} \For{<assign>}{<expr>} <command> \end{verbatim} \ACONTINUE -{ -\begin{algi}[pascal] +\begin{algorithmic}[1] \For{<$\relax$assign$\relax$>}{<$\relax$expr$\relax$>} \State $<$command$>$ -\end{algi} -} +\end{algorithmic} \AENDSKIP The \textbf{For} loop (as all other loops) ends after the following command (a block counts @@ -805,8 +808,7 @@ also as a single command). \end{algorithmic} \end{verbatim} \ACONTINUE -{ -\begin{alginc}[pascal] +\begin{algorithmic}[1] \Begin \State $sum:=0$; \State $prod:=1$; @@ -816,48 +818,44 @@ also as a single command). \State $prod:=prod*i$; \End \End. -\end{alginc} -} +\Statex +\end{algorithmic} \AEND \subsubsection{The \textbf{while} loop} -\noindent\begin{minipage}[c]{0.5\linewidth} +\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} \While{<expression>} <command> \end{verbatim} \ACONTINUE -{ -\begin{alginc}[pascal] +\begin{algorithmic}[1] \While{<$\relax$expression$\relax$>} \State $<$command$>$ -\end{alginc} -} +\end{algorithmic} \AEND \subsubsection{The \textbf{repeat}\dots\ \textbf{until} block} -\noindent\begin{minipage}[c]{0.5\linewidth} +\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} \Repeat <body> \Until{<expression>} \end{verbatim} \ACONTINUE -{ -\begin{alginc}[pascal] +\begin{algorithmic}[1] \Repeat \State $<$body$>$ \Until{<$\relax$expression$\relax$>} -\end{alginc} -} +\end{algorithmic} \AEND \subsubsection{The \textbf{if} command} -\noindent\begin{minipage}[c]{0.5\linewidth} +\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} \If{<expression>} <command> @@ -867,51 +865,45 @@ also as a single command). ] \end{verbatim} \ACONTINUE -{ -\begin{alginc}[pascal] +\begin{algorithmic}[1] \If{<$\relax$expression$\relax$>} \State $<$command$>$ \Statex \hskip-\algorithmicindent\hskip-\algorithmicindent[ \Else \State $<$command$>$ \Statex \hskip-\algorithmicindent\hskip-\algorithmicindent] -\end{alginc} -} +\end{algorithmic} \AENDSKIP Every \verb:\Else: matches the nearest \verb:\If:. \subsubsection{The \textbf{procedure} command} -\noindent\begin{minipage}[c]{0.5\linewidth} +\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} \Procedure <some text> \end{verbatim} \ACONTINUE -{ -\begin{alginc}[pascal] +\begin{algorithmic}[1] \Procedure $<$some text$>$ -\end{alginc} -} +\end{algorithmic} \AENDSKIP \verb:\Procedure: just writes the ``procedure'' word on a new -line... You should put manually the \verb:\Begin:\dots\ \verb:\End: +line... You will probably put a \verb:\Begin:\dots\ \verb:\End: block after it. \subsubsection{The \textbf{function} command} -\noindent\begin{minipage}[c]{0.5\linewidth} +\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} \Function<some text> \end{verbatim} \ACONTINUE -{ -\begin{alginc}[pascal] +\begin{algorithmic}[1] \Function $<$some text$>$ -\end{alginc} -} +\end{algorithmic} \AENDSKIP Just like \textbf{Procedure}. @@ -920,7 +912,7 @@ Just like \textbf{Procedure}. \subsection{The \textbf{algc} layout} -Sorry, the \textbf{algc} layout is incomplete. +Sorry, the \textbf{algc} layout is unfinished. The commands defined are: \begin{itemize} @@ -938,6 +930,7 @@ The commands defined are: \section{Custom algorithmic blocks}\label{algorithmicx} +\alglanguage{default} @@ -947,10 +940,10 @@ Most of the environments defined in the standard layouts (and most probably the ones you will define) are divided in two categories: \begin{description} -\item[Blocks] are the environments which contain an arbitrary number of +\item[Blocks] are the environments witch contain an arbitrary number of commands or nested blocks. Each block has a name, begins with a starting command and ends with an ending command. The commands in a block are -indented by \verb:\algorithmicindent: (or another amount, as you will see later in this section). +indented by \verb:\algorithmicindent: (or another amount). If your algorithm ends without closing all blocks, the \alg\ package gives you a nice error. So be good, and close them all! @@ -965,8 +958,8 @@ your algorithm (or a block) ends before the single command of a loop, then this is considered an empty command, and the loop is closed. Feel free to leave open loops at the end of blocks! -Most of the environments in the \verb:algpascal: and -\verb:algc: packages are loops. +Loops are most of the environments in the \verb:algpascal: and +\verb:algc: packages. \end{description} For some rare constructions you can create mixtures of the two @@ -1023,13 +1016,13 @@ macro will display the different texts you specified. If in the above definitions the \verb:<block>: is missing, then the name of the starting command is used as block name. If a block with the given name -already exists, these macros won't define a new block, instead of this the defined block will be used. -So both, the old and new starting and ending commands will open/close the block. -If \verb:<start>: or \verb:<end>: is empty, then +already exists, these macros don't define a new block, instead this it will be used the defined +block. If \verb:<start>: or \verb:<end>: is empty, then the definition does not define a new starting/ending command for the block, and then the respective text must be missing from the definition. You may have more starting and ending commands for one block. If the block name is missing, then a starting command must be given. + \bigskip\noindent\begin{minipage}[b]{0.5\linewidth} \begin{verbatim} \algblock[Name]{Start}{End} @@ -1079,8 +1072,8 @@ for one block. If the block name is missing, then a starting command must be giv \subsection{Defining loops} The loop defining macros are similar to the block defining macros. A loop has no ending command -and ends after the first statement, block or loop that follows the loop. -Since loops have no ending command, the macro \verb:\algloopx: would not have much sense. +and ends after the first state, block or loop that follows the loop. +Since loops have no ending command, the macro \verb:\algloopx: would not have mutch sense. The loop defining macros are: \begin{verbatim} @@ -1158,9 +1151,9 @@ then \verb:<continue>: is used as the new block name. It is not allowed to have \verb:<old block>: block/loop and opens the \verb:<new block>: block. Since \verb:<continue>: may end different blocks and loops, it can have different text at the end of the different blocks/loops. If the \verb:<continue>: command doesn't find an -\verb:<old block>: to close, an error is reported. +\verb:<old block>: to close, then an error is reported. -You can create continuing loops with the following macros: +Create continuing loops with the followings: \begin{verbatim} \algcloop[<new loop>]{<old block>}{<continue>} @@ -1195,7 +1188,7 @@ block/loop, and opens a \verb:<new loop>: loop. \EndIf \If \EndIf -\Eeee{Param} +\Eeee{Creep} \Oooo \end{algorithmic} \end{verbatim} @@ -1220,7 +1213,7 @@ block/loop, and opens a \verb:<new loop>: loop. \EndIf \If \EndIf -\Eeee{Param} +\Eeee{Creep} \Oooo \Statex \end{algorithmic} @@ -1266,8 +1259,8 @@ block/loop, and opens a \verb:<new loop>: loop. \subsection{Even more customisation}\label{setblock} With the following macros you can give the indentation used by the new block (or loop), -and the number of statements after which the "block" is automatically closed. This value is $\infty$ -for blocks, 1 for loops, and 0 for statements. There is a special value, 65535, meaning that the +and the number of stataments after that the "block" is automatically closed. This value is $\infty$ +for blocks, 1 for loops, and 0 for stataments. There is a special value, 65535, meaning that the defined "block" does not end automatically, but if it is enclosed in a block, then the ending command of the block closes this "block" as well. @@ -1299,7 +1292,7 @@ command of the block closes this "block" as well. [<endparamcount>][<default value>]{<end text>} \end{verbatim} -The \verb:<lifetime>: is the number of statements after that the block is closed. An empty +The \verb:<lifetime>: is the number of stataments after that the block is closed. An empty \verb:<lifetime>: field means $\infty$. The \verb:<indent>: gives the indentation of the block. Leave this field empty for the default indentation. The rest of the parameters has the same function as for the previous macros. @@ -1367,7 +1360,7 @@ The created environments behave as follows: \begin{itemize} \item It starts with \verb:\Start:. The nested environments are indented by 1 cm. -\item If it is followed by at least 3 environments (statements), then it closes +\item If it is followed by at least 3 environments (stataments), then it closes automatically after the third one. \item If you put a \verb:\Stop: before the automatic closure, then this \verb:\Stop: closes the environment. \verb:CStart: closes a block called \verb:Name: @@ -1381,7 +1374,7 @@ and opens a new one called \verb:CName: and having an indentaion of 2 cm. \subsection{Parameters, custom text}\label{custom text} With \verb:\algrenewtext: you can change the number of parameters, and the text displayed by the -commands. With \verb:algnotext: you can make the whole output line disappear, but +commands. With \verb:algnotext: you can makes the vole output line disappear, but it works only for ending commands, for beginning commands you will get an incorrect output. \begin{verbatim} @@ -1401,12 +1394,12 @@ for this block), use \verb:\algdefaulttext:. \algdefaulttext[<block>]{<command>} \end{verbatim} -If the \verb:<block>: is missing, the default text itself will be set to the default value +If the \verb:<block>: is missing, than the default text itself will be set to the default value (this is \verb:\textbf{<command>}:). -\subsection{The base defining macro} +\subsection{The ONE defining macro} All block and loop defining macros call the same macro. You may use this macro to gain a better acces to what will be defined. This macro is \verb:\algdef:. @@ -1436,7 +1429,7 @@ xN&ending command, with no text for this block\\ \hline b&block(default)\\ l&loop\\ -L&loop closes after the given number of statements\\ +L&loop closes after the given number of stataments\\ \hline i&indentation specified\\ \hline @@ -1504,7 +1497,7 @@ The block and loop defining macros call \verb:\algdef: with the following flags: \vfill \section{Examples} -\subsection{A full pseudocode example} +\subsection{A full example using \textbf{algpseudocode}} \begin{verbatim} @@ -1553,8 +1546,8 @@ The block and loop defining macros call \verb:\algdef: with the following flags: \end{verbatim} \eject -{ -\algsetlanguage{pseudocode} + +\alglanguage{pseudocode} \begin{algorithm}[h] \caption{The Bellman-Kalaba algorithm} \begin{algorithmic}[1] @@ -1592,18 +1585,184 @@ The block and loop defining macros call \verb:\algdef: with the following flags: \EndProcedure \end{algorithmic} \end{algorithm} -} +\eject + + + + +\subsection{Breaking up an algorithm} + + +\begin{verbatim} +\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} +\end{verbatim} +\eject + + +\alglanguage{pseudocode} +\begin{algorithm}[h] +\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} +\eject + + + + +\subsection{Using multiple layouts} + + +\begin{verbatim} +\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} +\end{verbatim} +\eject + + +\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} \eject \section{Bugs} -At this time there are no known bugs. If you find a bug, please create -a small \LaTeX{} file to demonstrate this, and contact me on: +If you have a question or find a bug you can contact me on: \medskip \textbf{szaszjanos@users.sourceforge.net} +\medskip +\noindent If possible, please create a small \LaTeX{} example related to your problem. + + \end{document} |