diff options
| -rw-r--r-- | Master/texmf-dist/doc/latex/algorithms/README | 27 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/algorithms/THANKS | 4 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/algorithms/algorithms.pdf | bin | 336114 -> 398737 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/algorithms/algorithms.tex | 487 | ||||
| -rw-r--r-- | Master/texmf-dist/tex/latex/algorithms/algorithmic.sty | 13 | ||||
| -rw-r--r-- | Master/texmf-dist/tpm/algorithms.tpm | 6 |
6 files changed, 336 insertions, 201 deletions
diff --git a/Master/texmf-dist/doc/latex/algorithms/README b/Master/texmf-dist/doc/latex/algorithms/README index 3279cdaefe7..f2a7588c1e8 100644 --- a/Master/texmf-dist/doc/latex/algorithms/README +++ b/Master/texmf-dist/doc/latex/algorithms/README @@ -1,8 +1,19 @@ -This package provides two environments, "algorithmic" and -"algorithm", which are designed to be used together but may -be used separately. The "algorithmic" environment provides -an environment for describing algorithms and the "algorithm" -environment provides a "float" wrapper for algorithms -(implemented using "algorithmic" or some other method at -the author's option). The reason that two environments are -provided is to allow the author maximum flexibility. +The "algorithms" bundle provides two environments, "algorithmic" and +"algorithm", which are designed to be used together but may be used +separately. + +The "algorithmic" environment provides an environment for describing +algorithms and the "algorithm" environment provides a "float" wrapper +for algorithms (implemented using "algorithmic" or some other method at +the author's option). + +The reason that two environments are provided is to allow the author +maximum flexibility. + +The algorithms bundle is (currently) licensed under the Lesser GPL +license, which is a Free Software license. It may, in the future, be +released under the standard LaTeX license (the Latex Project Public +License). + + + -- Rogério Brito <rbrito@users.berlios.de> Fri, 2 Jun 2006 21:54:10 -0300 diff --git a/Master/texmf-dist/doc/latex/algorithms/THANKS b/Master/texmf-dist/doc/latex/algorithms/THANKS index 265ed2f86c1..eab24ca3a7c 100644 --- a/Master/texmf-dist/doc/latex/algorithms/THANKS +++ b/Master/texmf-dist/doc/latex/algorithms/THANKS @@ -13,3 +13,7 @@ Original Author (1996-2004): Other Contributions (in lexicographic order): * Arnaud Giersch <giersch@icps.u-strasbg.fr> * Arnaud Legrand <Arnaud.Legrand@imag.fr> + * Fabian Mörchen <fabian@informatik.uni-marburg.de> + * Joachim Reichel <joachim.reichel@gmx.de> + * Manuel López-Ibáńez <m.lopez-ibanez@napier.ac.uk> + * Peter Wilson <herries.press@earthlink.net> diff --git a/Master/texmf-dist/doc/latex/algorithms/algorithms.pdf b/Master/texmf-dist/doc/latex/algorithms/algorithms.pdf Binary files differindex e1d4a26c3ef..ac087941fac 100644 --- a/Master/texmf-dist/doc/latex/algorithms/algorithms.pdf +++ b/Master/texmf-dist/doc/latex/algorithms/algorithms.pdf diff --git a/Master/texmf-dist/doc/latex/algorithms/algorithms.tex b/Master/texmf-dist/doc/latex/algorithms/algorithms.tex index 6affdad8b7c..251c1bad5ca 100644 --- a/Master/texmf-dist/doc/latex/algorithms/algorithms.tex +++ b/Master/texmf-dist/doc/latex/algorithms/algorithms.tex @@ -18,7 +18,7 @@ % Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, % USA. % -\documentclass{article} +\documentclass[letterpaper]{article} \usepackage[latin1]{inputenc} \usepackage[T1]{fontenc} @@ -26,6 +26,8 @@ \usepackage[pdfstartview={FitH}]{hyperref} \usepackage{algorithm} \usepackage{algorithmic} +\usepackage{amsthm} +\usepackage{multicol} \title{Algorithms} \author{Rogério Brito\\ @@ -35,11 +37,11 @@ \newcommand{\keyword}[1]{\texttt{#1}} \newcommand{\filename}[1]{\texttt{#1}} -\newcommand{\latcom}[1]{\texttt{$\backslash$#1}} \setcounter{tocdepth}{2} \begin{document} +\addtocontents{toc}{\protect\begin{multicols}{2}} \maketitle \tableofcontents %\listofalgorithms @@ -52,28 +54,30 @@ depending on the necessities of the author, be used separately. The \keyword{algorithmic} environment provides an environment for describing algorithms and the \keyword{algorithm} environment provides a -``float'' wrapper for algorithms (implemented using \keyword{algorithmic} -or some other method at the author's option). The reason that two -environments are provided is to allow the author maximum flexibility. +``float'' wrapper for algorithms (implemented using +\keyword{algorithmic} or some other method at the author's option). The +reason that two environments are provided is to allow the author maximum +flexibility. This work may be distributed and/or modified under the conditions of the GNU Lesser General Public License as published by the Free Software Foundation (see the file \filename{COPYING} included in this package). -Currently, this package consists of three files: \filename{algorithm.sty}, -\filename{algorithmic.sty} and \filename{algorithms.tex} (the source of -this document). This is likely to change in the near future. +Currently, this package consists of three files: +\filename{algorithm.sty}, \filename{algorithmic.sty} and +\filename{algorithms.tex} (the source of this document). This is likely +to change in the near future. -\section{The \keyword{algorithmic} Environment} +\section[Environment: \keyword{algorithmic}]% +{The \keyword{algorithmic} Environment} \label{sec:algorithmic-envir} Within an \keyword{algorithmic} a number of commands for typesetting -popular algorithmic constructs are available. -In general, the commands provided can be arbitrarily nested to -describe quite complex algorithms. +popular algorithmic constructs are available. In general, the commands +provided can be arbitrarily nested to describe quite complex algorithms. An optional argument to the \verb+\begin{algorithmic}+ statement can be -used to turn on line numbering by giving a positive integer indicating the -required frequency of line numbering. -For example, \verb+\begin{algorithmic}[5]+ would cause every fifth line to -be numbered. + used to turn on line numbering by giving a positive integer indicating + the required frequency of line numbering. For example, + \verb+\begin{algorithmic}[5]+ would cause every fifth line to be + numbered. \subsection{The Simple Statement} @@ -102,16 +106,15 @@ would produce \STATE $S \leftarrow 0$ \end{algorithmic} For users of earlier versions of \keyword{algorithmic} this construct is -a cause of an incompatibility. -In the earlier version, instead of starting simple statements with the -\verb+\STATE+ -command, simple statements were entered as free text and terminated with -\verb+\\+ command. -Unfortunately, this simpler method failed to survive the modifications -necessary for statement numbering. -However, the \verb+\\+ command can still be used to force a line break within -a simple statement. - +a cause of an incompatibility. In the earlier version, instead of +starting simple statements with the \verb+\STATE+ command, simple +statements were entered as free text and terminated with \verb+\\+ +command. Unfortunately, this simpler method failed to survive the +modifications necessary for statement numbering. However, the \verb+\\+ +command can still be used to force a line break within a simple +statement. + +%\subsection{The \emph{if-then-else} Statement} \subsection{The \emph{if-then-else} Construct} The \emph{if-then-else} construct takes the forms. @@ -120,9 +123,8 @@ The \emph{if-then-else} construct takes the forms. \IF{<condition>} <text1> \ELSE <text2> \ENDIF \IF{<condition1>} <text1> \ELSIF{<condition2>} <text2> \ELSE <text3> \ENDIF \end{verbatim} -In the third of these forms there is no limit placed on the number -of \verb+\ELSIF{<C>}+ that may be used. -For example, +In the third of these forms there is no limit placed on the number of +\verb+\ELSIF{<C>}+ that may be used. For example, \begin{verbatim} \begin{algorithmic} \IF{some condition is true} @@ -139,13 +141,13 @@ For example, would produce \begin{algorithmic} \IF{some condition is true} - \STATE do some processing + \STATE do some processing \ELSIF{some other condition is true} - \STATE do some different processing + \STATE do some different processing \ELSIF{some even more bizarre condition is met} - \STATE do something else + \STATE do something else \ELSE - \STATE do the default actions + \STATE do the default actions \ENDIF \end{algorithmic} with appropriate indentations. @@ -168,7 +170,7 @@ For example, produces \begin{algorithmic} \FOR{$i=0$ to $10$} - \STATE carry out some processing + \STATE carry out some processing \ENDFOR \end{algorithmic} and @@ -182,7 +184,7 @@ and produces \begin{algorithmic}[1] \FORALL{$i$ such that $0\leq i\leq 10$} - \STATE carry out some processing + \STATE carry out some processing \ENDFOR \end{algorithmic} @@ -203,7 +205,7 @@ For example, produces \begin{algorithmic} \WHILE{some condition holds} - \STATE carry out some processing + \STATE carry out some processing \ENDWHILE \end{algorithmic} @@ -224,7 +226,7 @@ For example, produces \begin{algorithmic} \REPEAT - \STATE carry out some processing + \STATE carry out some processing \UNTIL{some condition is met} \end{algorithmic} @@ -245,7 +247,7 @@ For example, produces \begin{algorithmic} \LOOP - \STATE this processing will be repeated forever + \STATE this processing will be repeated forever \ENDLOOP \end{algorithmic} @@ -303,11 +305,38 @@ produces \RETURN $(x+y)/2$ \end{algorithmic} + +\subsubsection{The ``true'' and ``false'' Values} + +Since many algorithms have the necessity of returning \emph{true} or +\emph{false} values, \keyword{algorithms}, starting with version +2006-06-02, includes the keywords \verb+\TRUE+ and \verb+\FALSE+, +which are intented to print the values in a standard fashion, like the +following snippet of an algorithm to decide if an integer $n$ is even or +odd: +\begin{verbatim} +\begin{algorithmic} + \IF{$n$ is odd} + \RETURN \TRUE + \ELSE + \RETURN \FALSE + \ENDIF +\end{algorithmic} +\end{verbatim} +The code above produces the following output: +\begin{algorithmic} + \IF{$n$ is odd} + \RETURN \TRUE + \ELSE + \RETURN \FALSE + \ENDIF +\end{algorithmic} + \subsection{Printing Messages} Another feature of the \keyword{algorithmic} environment is that it -currently provides a standard way of printing values (which is an operation -used enough to merit its own keyword). It has the syntax: +currently provides a standard way of printing values (which is an +operation used enough to merit its own keyword). It has the syntax: \begin{verbatim} \PRINT <text> \end{verbatim} @@ -341,20 +370,19 @@ produces Because the mechanisms used to build the various algorithmic structures make it difficult to use the above mechanism for placing comments at the end of the first line of a construct, the commands \verb+\IF+, -\verb+\ELSIF+, \verb+\ELSE+, \verb+\WHILE+, \verb+\FOR+, -\verb+\FORALL+, \verb+\REPEAT+ -and \verb+\LOOP+ all take an optional argument which will be treated -as a comment to be placed at the end of the line on which they appear. -For example, +\verb+\ELSIF+, \verb+\ELSE+, \verb+\WHILE+, \verb+\FOR+, \verb+\FORALL+, +\verb+\REPEAT+ and \verb+\LOOP+ all take an optional argument which will +be treated as a comment to be placed at the end of the line on which +they appear. For example, \begin{algorithmic} \REPEAT[this is comment number one] - \IF[this is comment number two]{condition one is met} + \IF[this is comment number two]{condition one is met} \STATE do something - \ELSIF[this is comment number three]{condition two is met} + \ELSIF[this is comment number three]{condition two is met} \STATE do something else - \ELSE[this is comment number four] + \ELSE[this is comment number four] \STATE do nothing - \ENDIF + \ENDIF \UNTIL{hell freezes over} \end{algorithmic} @@ -384,45 +412,49 @@ will produce \begin{algorithmic} \REQUIRE $n \geq 0$ \ENSURE $y = x^n$ + \STATE $y \Leftarrow 1$ \STATE $X \Leftarrow x$ \STATE $N \Leftarrow n$ \WHILE{$N \neq 0$} - \IF{$N$ is even} - \STATE $X \Leftarrow X \times X$ - \STATE $N \Leftarrow N / 2$ - \ELSE[$N$ is odd] - \STATE $y \Leftarrow y \times X$ - \STATE $N \Leftarrow N - 1$ - \ENDIF + \IF{$N$ is even} + \STATE $X \Leftarrow X \times X$ + \STATE $N \Leftarrow N / 2$ + \ELSE[$N$ is odd] + \STATE $y \Leftarrow y \times X$ + \STATE $N \Leftarrow N - 1$ + \ENDIF \ENDWHILE \end{algorithmic} which is an algorithm for finding the value of a number taken to a non-negative power. -\subsection{Options and Customization} +\subsection[Options/Customization]% +{Options and Customization} There is a single option, \keyword{noend}\label{kwd:noend} that may be -invoked when the \texttt{algorithmic} package is loaded. With this option -invoked the \emph{end} statements are omitted in the output. This allows -space to be saved in the output document when this is an issue. +invoked when the \texttt{algorithmic} package is loaded. With this +option invoked the \emph{end} statements are omitted in the output. +This allows space to be saved in the output document when this is an +issue. \subsubsection{Changing Indentation} \label{sec:changing-indentation} -In the spirit of saving vertical space (which is especially important when -submitting a paper for a journal, where space is frequently limited for -authors), the \keyword{algorithmic} environment offers, beginning with the -version released in 2005-05-08, a way to control the amount of indentation -that is used by a given algorithm. +In the spirit of saving vertical space (which is especially important +when submitting a paper for a journal, where space is frequently limited +for authors), the \keyword{algorithmic} environment offers, beginning +with the version released in 2005-05-08, a way to control the amount of +indentation that is used by a given algorithm. The amount of indentation to be used is given by the command \begin{verbatim} \algsetup{indent=lenght} \end{verbatim} -where \emph{length} is any valid length used by \TeX. The default value of -the indentation used by the \keyword{algorithmic} environment is $1$ em -(for ``backward compatibility reasons''), but a value of $2$ em or more is -recommended, depending on the publication. For example, the snippet +where \emph{length} is any valid length used by \TeX. The default value +of the indentation used by the \keyword{algorithmic} environment is $1$ +em (for ``backward compatibility reasons''), but a value of $2$ em or +more is recommended, depending on the publication. For example, the +snippet \begin{verbatim} \algsetup{indent=2em} \begin{algorithmic}[1] @@ -438,9 +470,9 @@ produces \begin{algorithmic}[1] \STATE $a \Leftarrow 1$ \IF{$a$ is even} - \PRINT ``$a$ is even'' + \PRINT ``$a$ is even'' \ELSE - \PRINT ``$a$ is odd'' + \PRINT ``$a$ is odd'' \ENDIF \end{algorithmic} while @@ -459,17 +491,17 @@ would produce \begin{algorithmic}[1] \STATE $a \Leftarrow 1$ \IF{$a$ is even} - \PRINT ``$a$ is even'' + \PRINT ``$a$ is even'' \ELSE - \PRINT ``$a$ is odd'' + \PRINT ``$a$ is odd'' \ENDIF \end{algorithmic} \algsetup{indent=1em} The intended use of this option is to allow the author to omit the \emph{end} (see Section~\ref{kwd:noend} for details) statements without -loosing readability, by increasing the amount of indentation to a suitable -level. +loosing readability, by increasing the amount of indentation to a +suitable level. \subsubsection{Changing Line Numbering} @@ -478,9 +510,10 @@ Section~\ref{sec:changing-indentation}, \keyword{algorithms} already provides you with the possibility of numbering lines. Starting with the version released in 2005-07-05, you can now change two -aspects of line numbering: the size of the line numbers (which, by default, -is \verb+\footnotesize+) and the delimiter used to separate the line number -from the code (which, by default, is \verb+:+, i.e., a colon). +aspects of line numbering: the size of the line numbers (which, by +default, is \verb+\footnotesize+) and the delimiter used to separate the +line number from the code (which, by default, is \verb+:+, i.e., a +colon). You can change the size of the line numbers using the command: \begin{verbatim} @@ -488,17 +521,18 @@ You can change the size of the line numbers using the command: \end{verbatim} where \emph{size} is any of the various commands provided by \LaTeX\ to change the size of the font to be used. Among others, useful values are -\verb+\tiny+, \verb+\scriptsize+, \verb+\footnotesize+ and \verb+\small+. -Please see the complete list of sizes in your \LaTeX\ documentation. +\verb+\tiny+, \verb+\scriptsize+, \verb+\footnotesize+ and +\verb+\small+. Please see the complete list of sizes in your \LaTeX\ +documentation. -As another frequently requested feature, you can change the delimiter used -with the line numbers by issuing the command: +As another frequently requested feature, you can change the delimiter +used with the line numbers by issuing the command: \begin{verbatim} \algsetup{linenodelimiter=delimiter} \end{verbatim} -where \emph{delimiter} is any ``well-formed'' string, including the empty -string. With this command, you can change the colon to a period (\verb+.+) -by issuing the command +where \emph{delimiter} is any ``well-formed'' string, including the +empty string. With this command, you can change the colon to a period +(\verb+.+) by issuing the command \begin{verbatim} \algsetup{linenodelimiter=.} \end{verbatim} @@ -507,16 +541,21 @@ or even omit the delimiter, by specifying the empty string or a space As an example of such commands, the code produced by \begin{verbatim} -\algsetup{linenosize=\small, - linenodelimiter=.} +\algsetup{ + linenosize=\small, + linenodelimiter=. +} \begin{algorithmic}[1] \STATE $i \leftarrow 10$ - \RETURN $i$ + \RETURN $i$ \end{algorithmic} \end{verbatim} would be something like -\algsetup{linenosize=\small, - linenodelimiter=.} + +\algsetup{ + linenosize=\small, + linenodelimiter=. +} \begin{algorithmic}[1] \STATE $i \leftarrow 10$ \RETURN $i$ @@ -526,9 +565,9 @@ would be something like \subsubsection{Customization} -In order to facilitate the use of this package with foreign languages, all -of the words in the output are produced via redefinable macro commands. -The default definitions of these macros are: +In order to facilitate the use of this package with foreign languages, +all of the words in the output are produced via redefinable macro +commands. The default definitions of these macros are: \begin{verbatim} \newcommand{\algorithmicrequire}{\textbf{Require:}} \newcommand{\algorithmicensure}{\textbf{Ensure:}} @@ -550,65 +589,57 @@ The default definitions of these macros are: \newcommand{\algorithmicuntil}{\textbf{until}} \newcommand{\algorithmicprint}{\textbf{print}} \newcommand{\algorithmicreturn}{\textbf{return}} +\newcommand{\algorithmictrue}{\textbf{true}} +\newcommand{\algorithmicfalse}{\textbf{false}} +\end{verbatim} + +If you would like to change the definition of these commands to another +content, then you should use, in your own document, the standard +\LaTeX{} command \keyword{renewcommand}, with an usage like this: +\begin{verbatim} +\renewcommand{\algorithmicrequire}{\textbf{Input:}} +\renewcommand{\algorithmicensure}{\textbf{Output:}} \end{verbatim} -In addition, the formatting of comments is implemented via a single -argument command macro which may also be redefined. -The default definition is +\paragraph{About the Way Comments Are Formatted} + +The formatting of comments is implemented via a single argument command +macro which may also be redefined. The default definition is \begin{verbatim} \newcommand{\algorithmiccomment}[1]{\{#1\}} \end{verbatim} -and another option that may be interesting for users familiar with C-like -languages is to redefine the comments to be +and another option that may be interesting for users familiar with +C-like languages is to redefine the comments to be \begin{verbatim} -\renewcommand{\algorithmiccomment}[1]{//#1} +\renewcommand{\algorithmiccomment}[1]{// #1} \end{verbatim} - Comments produced this way would be like this: -\renewcommand{\algorithmiccomment}[1]{//#1} +\renewcommand{\algorithmiccomment}[1]{// #1} \begin{algorithmic} \STATE $i \leftarrow i +1$ \COMMENT{Increments $i$} \end{algorithmic} This second way to present comments may become the default in a future -version of the package. +version of this package. -\section{The \keyword{algorithm} Environment} +\section[Environment: \keyword{algorithm}]% +{The \keyword{algorithm} Environment} \subsection{General} -\begin{algorithm} -\caption{Calculate $y = x^n$} -\label{alg1} -\begin{algorithmic} -\REQUIRE $n \geq 0 \vee x \neq 0$ -\ENSURE $y = x^n$ -\STATE $y \Leftarrow 1$ -\IF{$n < 0$} -\STATE $X \Leftarrow 1 / x$ -\STATE $N \Leftarrow -n$ -\ELSE -\STATE $X \Leftarrow x$ -\STATE $N \Leftarrow n$ -\ENDIF -\WHILE{$N \neq 0$} -\IF{$N$ is even} -\STATE $X \Leftarrow X \times X$ -\STATE $N \Leftarrow N / 2$ -\ELSE[$N$ is odd] -\STATE $y \Leftarrow y \times X$ -\STATE $N \Leftarrow N - 1$ -\ENDIF -\ENDWHILE -\end{algorithmic} -\end{algorithm} When placed within the text without being encapsulated in a floating environment \texttt{algorithmic} environments may be split over a page -boundary greatly detracting from their appearance. -In addition, it is useful to have algorithms numbered for reference -and for lists of algorithms to be appended to the list of contents. -The \texttt{algorithm} environment is meant to address these concerns -by providing a floating environment for algorithms. -For example, the input text +boundary, greatly detracting from their appearance.\footnote{This is the + expected behaviour for floats in \LaTeX. If you don't care about + having your algorithm split between pages, then one option that you + have is to ignore the \texttt{algorithm} environment.} In addition, it +is useful to have algorithms numbered for reference and for lists of +algorithms to be appended to the list of contents. The +\texttt{algorithm} environment is meant to address these concerns by +providing a floating environment for algorithms. + +\subsection{An Example} +To illustrate the use of the \texttt{algorithm} environment, the +following text \begin{verbatim} \begin{algorithm} \caption{Calculate $y = x^n$} @@ -638,41 +669,65 @@ For example, the input text \end{verbatim} produces Algorithm~\ref{alg1} which is a slightly modified version of the earlier algorithm for determining the value of a number taken to an -integer power. -In this case, provided the power may be negative provided the number is -not zero. +integer power. In this case, provided the power may be negative +provided the number is not zero. + +\begin{algorithm}[H] + \caption{Calculate $y = x^n$} + \label{alg1} + \begin{algorithmic} + \REQUIRE $n \geq 0 \vee x \neq 0$ + \ENSURE $y = x^n$ + + \STATE $y \Leftarrow 1$ + \IF{$n < 0$} + \STATE $X \Leftarrow 1 / x$ + \STATE $N \Leftarrow -n$ + \ELSE + \STATE $X \Leftarrow x$ + \STATE $N \Leftarrow n$ + \ENDIF + + \WHILE{$N \neq 0$} + \IF{$N$ is even} + \STATE $X \Leftarrow X \times X$ + \STATE $N \Leftarrow N / 2$ + \ELSE[$N$ is odd] + \STATE $y \Leftarrow y \times X$ + \STATE $N \Leftarrow N - 1$ + \ENDIF + \ENDWHILE + \end{algorithmic} +\end{algorithm} -The command \verb+\listofalgorithms+ may be used to produce a list -of algorithms as part of the table contents as shown at the beginning of -this document. -An auxiliary file with a suffix of \texttt{.loa} is produced when this -feature is used. +The command \verb+\listofalgorithms+ may be used to produce a list of +algorithms as part of the table contents as shown at the beginning of +this document. An auxiliary file with a suffix of \texttt{.loa} is +produced when this feature is used. \subsection{Options} The appearance of the typeset algorithm may be changed by use of the options: \texttt{plain}, \texttt{boxed} or \texttt{ruled} during the -loading of the \texttt{algorithm} package. -The default option is \texttt{ruled}. +loading of the \texttt{algorithm} package. The default option is +\texttt{ruled}. The numbering of algorithms can be influenced by providing the name of the document component within which numbering should be recommenced. The legal values for this option are: \texttt{part}, \texttt{chapter}, -\texttt{section}, \texttt{subsection}, \texttt{subsubsection} -or \texttt{nothing}. -The default value is \texttt{nothing} which causes algorithms to be -numbered sequentially throughout the document. +\texttt{section}, \texttt{subsection}, \texttt{subsubsection} or +\texttt{nothing}. The default value is \texttt{nothing} which causes +algorithms to be numbered sequentially throughout the document. \subsection{Customization} In order to facilitate the use of this package with foreign languages, methods have been provided to facilitate the necessary modifications. -The title used in the caption within \texttt{algorithm} environment -can be set by use of the standard \verb+\floatname+ command which is +The title used in the caption within \texttt{algorithm} environment can +be set by use of the standard \verb+\floatname+ command which is provided as part of the \texttt{float} package which was used to -implement this package. -For example, +implement this package. For example, \begin{verbatim} \floatname{algorithm}{Procedure} \end{verbatim} @@ -681,48 +736,108 @@ within the caption of algorithms. In a manner analogous to that available for the built in floating environments, the heading used for the list of algorithms may be changed -by redefining the command \verb+listalgorithmname+. -The default definition for this command is +by redefining the command \verb+listalgorithmname+. The default +definition for this command is \begin{verbatim} \newcommand{\listalgorithmname}{List of Algorithms} \end{verbatim} -\section{Labels and References in Algorithms} +\subsubsection{Placement of Algorithms} + +One important fact that many users may not have noticed is that the +\texttt{algorithm} environment is actually built with the \texttt{float} +package and \texttt{float}, in turn, uses David Carlisle's \textsf{here} +style option. This means that the floats generated by the +\texttt{algorithm} environment accept a special option, namely, +\textbf{[H]}, with a capital `H', instead of the usual `h' offered by +plain \LaTeX. + +This option works as a stronger request of ``please put the float +here'': instead of just a suggestion for \LaTeX, it actually means ``put +this float HERE'', which is something desired by many. The two +algorithms typeset in this document use this option. + +\theoremstyle{definition} +\newtheorem*{warning*}{Warning} + +\medskip +\begin{warning*} + You \emph{can't} use the `H' positioning option together with the + usual `h' (for ``here''), `b' (for ``bottom'') etc. This is a + limitation (as far as I know) of the \texttt{float.sty} package. +\end{warning*} + +\section[References in Algorithms]% +{Labels and References in Algorithms} With the release of 2005-07-05, now \keyword{algorithmic} accepts labels -and references to specific lines of a given algorithm, so you don't have to -hardcode the line numbers yourself when trying to explain what the code -does in your texts. Thanks to Arnaud Legrand for the suggestion and patch -for this highly missed feature. +and references to specific lines of a given algorithm, so you don't have +to hardcode the line numbers yourself when trying to explain what the +code does in your texts. Thanks to Arnaud Legrand for the suggestion +and patch for this highly missed feature. An example of its use is shown in Algorithm~\ref{alg2}. -\begin{algorithm}[h!] -\caption{Calculate $y = x^n$} -\label{alg2} -\begin{algorithmic}[1] -\REQUIRE $n \geq 0 \vee x \neq 0$ -\ENSURE $y = x^n$ -\STATE $y \Leftarrow 1$ -\IF{$n < 0$} -\STATE $X \Leftarrow 1 / x$ -\STATE $N \Leftarrow -n$ -\ELSE -\STATE $X \Leftarrow x$ -\STATE $N \Leftarrow n$ -\ENDIF -\WHILE{$N \neq 0$} -\IF{$N$ is even}\label{alg:n-is-even} -\STATE $X \Leftarrow X \times X$ -\STATE $N \Leftarrow N / 2$ -\ELSE\label{alg:n-is-odd} -\STATE $y \Leftarrow y \times X$ -\STATE $N \Leftarrow N - 1$ -\ENDIF -\ENDWHILE -\end{algorithmic} +\begin{algorithm}[H] + \caption{Calculate $y = x^n$} + \label{alg2} + \begin{algorithmic}[1] + \REQUIRE $n \geq 0 \vee x \neq 0$ + \ENSURE $y = x^n$ + \STATE $y \Leftarrow 1$ + \IF{$n < 0$} + \STATE $X \Leftarrow 1 / x$ + \STATE $N \Leftarrow -n$ + \ELSE + \STATE $X \Leftarrow x$ + \STATE $N \Leftarrow n$ + \ENDIF + \WHILE{$N \neq 0$} + \IF{$N$ is even}\label{alg:n-is-even} + \STATE $X \Leftarrow X \times X$ + \STATE $N \Leftarrow N / 2$ + \ELSE\label{alg:n-is-odd} + \STATE $y \Leftarrow y \times X$ + \STATE $N \Leftarrow N - 1$ + \ENDIF + \ENDWHILE + \end{algorithmic} \end{algorithm} -See that, in line~\ref{alg:n-is-even}, we deal with the case of $N$ being -even, while, in line~\ref{alg:n-is-odd}, we give treatment to the case of -$N$ being odd. +See that, in line~\ref{alg:n-is-even}, we deal with the case of $N$ +being even, while, in line~\ref{alg:n-is-odd}, we give treatment to the +case of $N$ being odd. The numbers you see on this document were +generated automatically from the source document. + + +\section[Known Issues]{Issues Between \texttt{algorithms} and + \href{http://www.ctan.org/tex-archive/help/Catalogue/entries/tocbibind.html}{\texttt{tocbibind}} + or \href{http://www.ctan.org/tex-archive/help/Catalogue/entries/memoir.html}{\texttt{memoir}}} + +It +\href{http://groups.google.com/group/comp.text.tex/browse_thread/thread/4094e0c4f4fbd83e/a80a3f4666c794f0?fwc=1}{has + been discussed} in late 2005 that \texttt{algorithms} may have bad +interactions with the +\href{http://www.ctan.org/tex-archive/help/Catalogue/entries/tocbibind.html}{\texttt{tocbibind}} +or the +\href{http://www.ctan.org/tex-archive/help/Catalogue/entries/memoir.html}{\texttt{memoir}} +package (which includes \texttt{tocbibind}). + +A workaround has been suggested for the problem. After including +something like +\begin{verbatim} +\usepackage[nottoc]{tocbibind} +\end{verbatim} +in the preamble of your document, you can put, after +\verb+\begin{document}+, the following snippet of code: +\begin{verbatim} +\renewcommand{\listofalgorithms}{\begingroup + \tocfile{List of Algorithms}{loa} +\endgroup} + +\makeatletter +\let\l@algorithm\l@figure +\makeatother +\end{verbatim} +which should make the command \verb+\listofalgorithms+ work as expected. +\addtocontents{toc}{\protect\end{multicols}} \end{document} diff --git a/Master/texmf-dist/tex/latex/algorithms/algorithmic.sty b/Master/texmf-dist/tex/latex/algorithms/algorithmic.sty index 16a5fc3d579..a8ea2546bc7 100644 --- a/Master/texmf-dist/tex/latex/algorithms/algorithmic.sty +++ b/Master/texmf-dist/tex/latex/algorithms/algorithmic.sty @@ -16,7 +16,7 @@ % Boston, MA 02111-1307, USA. % \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{algorithmic}[2005/07/05] +\ProvidesPackage{algorithmic}[2006/06/02] \typeout{Document Style `algorithmic' - environment} % \RequirePackage{ifthen} @@ -75,6 +75,8 @@ \newcommand{\algorithmicuntil}{\textbf{until}} \newcommand{\algorithmicprint}{\textbf{print}} \newcommand{\algorithmicreturn}{\textbf{return}} +\newcommand{\algorithmictrue}{\textbf{true}} +\newcommand{\algorithmicfalse}{\textbf{false}} \def\ALC@setref{% \def\@currentlabel{\theALC@line}% } @@ -106,7 +108,7 @@ \newenvironment{algorithmic}[1][0]{ \setcounter{ALC@depth}{\@listdepth}% \let\@listdepth\c@ALC@depth% -\let\@item\ALC@item +\let\@item\ALC@item% \newcommand{\ALC@lno}{% \ifthenelse{\equal{\arabic{ALC@rem}}{0}} {{\ALC@linenosize \arabic{ALC@line}\ALC@linenodelimiter}}{}% @@ -126,14 +128,17 @@ } } {\end{list}} - \newcommand{\ALC@it}{\refstepcounter{ALC@line}\refstepcounter{ALC@rem}\ifthenelse{\equal{\arabic{ALC@rem}}{#1}}{\setcounter{ALC@rem}{0}}{}\item\ALC@setref} + \newcommand{\ALC@it}{\refstepcounter{ALC@rem}\refstepcounter{ALC@line}\ifthenelse{\equal{\arabic{ALC@rem}}{#1}}{\setcounter{ALC@rem}{0}}{}\item\ALC@setref} \newcommand{\ALC@com}[1]{\ifthenelse{\equal{##1}{default}}% {}{\ \algorithmiccomment{##1}}} \newcommand{\REQUIRE}{\item[\algorithmicrequire]} \newcommand{\ENSURE}{\item[\algorithmicensure]} \newcommand{\PRINT}{\ALC@it\algorithmicprint{}\ \ } \newcommand{\RETURN}{\ALC@it\algorithmicreturn{}\ \ } + \newcommand{\TRUE}{\algorithmictrue{}} + \newcommand{\FALSE}{\algorithmicfalse{}} \newcommand{\STATE}{\ALC@it} + \newcommand{\STMT}{\ALC@it} \newcommand{\COMMENT}[1]{\algorithmiccomment{##1}} \newenvironment{ALC@if}{\begin{ALC@g}}{\end{ALC@g}} \newenvironment{ALC@for}{\begin{ALC@g}}{\end{ALC@g}} @@ -173,7 +178,7 @@ \newcommand{\ENDLOOP}{\end{ALC@loop}\ALC@it\algorithmicendloop} } \renewcommand{\@toodeep}{} - \begin{list}{\ALC@lno}{\setcounter{ALC@line}{0}\setcounter{ALC@rem}{0}% + \begin{list}{\ALC@lno}{\setcounter{ALC@rem}{0}\setcounter{ALC@line}{0}% \itemsep\z@ \itemindent\z@ \listparindent\z@% \partopsep\z@ \parskip\z@ \parsep\z@% \labelsep 0.5em \topsep 0.2em% diff --git a/Master/texmf-dist/tpm/algorithms.tpm b/Master/texmf-dist/tpm/algorithms.tpm index ffeff1f7965..bf0b1bea30d 100644 --- a/Master/texmf-dist/tpm/algorithms.tpm +++ b/Master/texmf-dist/tpm/algorithms.tpm @@ -3,7 +3,7 @@ <rdf:Description about="http://texlive.dante.de/texlive/Package/algorithms.zip"> <TPM:Name>algorithms</TPM:Name> <TPM:Type>Package</TPM:Type> - <TPM:Date>2006/01/09 00:49:07</TPM:Date> + <TPM:Date>2006/06/03 00:33:00</TPM:Date> <TPM:Version></TPM:Version> <TPM:Creator>rahtz</TPM:Creator> <TPM:Title>Floating algorithm environment.</TPM:Title> @@ -18,12 +18,12 @@ popular algorithmic constructs are available. <TPM:Author>unknown</TPM:Author> <TPM:Size>395018</TPM:Size> <TPM:Build/> - <TPM:RunFiles size="11627"> + <TPM:RunFiles size="11834"> texmf-dist/tex/latex/algorithms/algorithm.sty texmf-dist/tex/latex/algorithms/algorithmic.sty texmf-dist/tpm/algorithms.tpm </TPM:RunFiles> - <TPM:DocFiles size="383391"> + <TPM:DocFiles size="450866"> texmf-dist/doc/latex/algorithms/COPYING texmf-dist/doc/latex/algorithms/README texmf-dist/doc/latex/algorithms/THANKS |