algorithmic.sty

%%
%% This is file `algorithmic.sty',
%% generated with the docstrip utility.
%%
%% The original source files were:
%%
%% algorithms.dtx  (with options: `algorithmic')
%% 
%% Copyright 1994-2004   Peter Williams <pwil3058@bigpond.net.au>
%% Copyright 2005-2011   Rogerio Theodoro de Brito <rbrito@ime.usp.br>
%% 
%% This document file is free software; you can redistribute it and/or
%% modify it under the terms of the GNU Lesser General Public License as
%% published by the Free Software Foundation; either version 2 of the
%% License, or (at your option) any later version.
%% 
%% This document file is distributed in the hope that it will be useful, but
%% WITHOUT ANY WARRANTY; without even the implied warranty of
%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser
%% General Public License for more details.
%% 
%% You should have received a copy of the GNU Lesser General Public License
%% along with this document file; if not, write to the Free Software
%% Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
%% USA.
%% 
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesPackage{algorithmic}
   [2011/09/23 v0.2 Document Style `algorithmic']

\RequirePackage{ifthen}
\RequirePackage{keyval}
\newboolean{ALC@noend}
\setboolean{ALC@noend}{false}
\newcounter{ALC@unique}    % new counter to make lines numbers be internally
\setcounter{ALC@unique}{0} % different in different algorithms
\newcounter{ALC@line}      % counter for current line
\newcounter{ALC@rem}       % counter for lines not printed
\newcounter{ALC@depth}
\newlength{\ALC@tlm}

\DeclareOption{noend}{\setboolean{ALC@noend}{true}}

\ProcessOptions

\def\algsetup{\setkeys{ALG}}

\newlength{\algorithmicindent}
\setlength{\algorithmicindent}{0pt}
\define@key{ALG}{indent}{\setlength{\algorithmicindent}{#1}}
\ifthenelse{\lengthtest{\algorithmicindent=0pt}}%
        {\setlength{\algorithmicindent}{1em}}{}

\newcommand{\ALC@linenodelimiter}{:}
\define@key{ALG}{linenodelimiter}{\renewcommand{\ALC@linenodelimiter}{#1}}

\newcommand{\ALC@linenosize}{\footnotesize}
\define@key{ALG}{linenosize}{\renewcommand{\ALC@linenosize}{#1}}

\@ifundefined{@number}{\newcommand{\@number}[1]{#1}}{}

\newcommand{\algorithmicrequire}{\textbf{Require:}}
\newcommand{\algorithmicensure}{\textbf{Ensure:}}
\newcommand{\algorithmiccomment}[1]{\{#1\}}
\newcommand{\algorithmicend}{\textbf{end}}
\newcommand{\algorithmicif}{\textbf{if}}
\newcommand{\algorithmicthen}{\textbf{then}}
\newcommand{\algorithmicelse}{\textbf{else}}
\newcommand{\algorithmicelsif}{\algorithmicelse\ \algorithmicif}
\newcommand{\algorithmicendif}{\algorithmicend\ \algorithmicif}
\newcommand{\algorithmicfor}{\textbf{for}}
\newcommand{\algorithmicforall}{\textbf{for all}}
\newcommand{\algorithmicdo}{\textbf{do}}
\newcommand{\algorithmicendfor}{\algorithmicend\ \algorithmicfor}
\newcommand{\algorithmicwhile}{\textbf{while}}
\newcommand{\algorithmicendwhile}{\algorithmicend\ \algorithmicwhile}
\newcommand{\algorithmicloop}{\textbf{loop}}
\newcommand{\algorithmicendloop}{\algorithmicend\ \algorithmicloop}
\newcommand{\algorithmicrepeat}{\textbf{repeat}}
\newcommand{\algorithmicuntil}{\textbf{until}}
\newcommand{\algorithmicswitch}{\textbf{switch}}
\newcommand{\algorithmicendswitch}{\algorithmicend\ \algorithmicswitch}
\newcommand{\algorithmiccase}{\textbf{case}}
\newcommand{\algorithmicendcase}{\algorithmicend\ \algorithmiccase}
\newcommand{\algorithmicotherwise}{\textbf{otherwise}}
\newcommand{\algorithmicendotherwise}{\algorithmicend\ \algorithmicotherwise}
\newcommand{\algorithmicupon}{\textbf{upon}}
\newcommand{\algorithmicendupon}{\algorithmicend\ \algorithmicupon}
\newcommand{\algorithmicproc}{\textbf{procedure}}
\newcommand{\algorithmicendproc}{\algorithmicend\ \algorithmicproc}
\newcommand{\algorithmicprint}{\textbf{print}}
\newcommand{\algorithmicreturn}{\textbf{return}}
\newcommand{\algorithmicand}{\textbf{and}}
\newcommand{\algorithmicor}{\textbf{or}}
\newcommand{\algorithmicxor}{\textbf{xor}}
\newcommand{\algorithmicnot}{\textbf{not}}
\newcommand{\algorithmicto}{\textbf{to}}
\newcommand{\algorithmicinputs}{\textbf{inputs}}
\newcommand{\algorithmicoutputs}{\textbf{outputs}}
\newcommand{\algorithmicglobals}{\textbf{globals}}
\newcommand{\algorithmicbody}{\textbf{do}}
\newcommand{\algorithmictrue}{\textbf{true}}
\newcommand{\algorithmicfalse}{\textbf{false}}

\def\ALC@item[#1]{%
\if@noparitem \@donoparitem
  \else \if@inlabel \indent \par \fi
         \ifhmode \unskip\unskip \par \fi
         \if@newlist \if@nobreak \@nbitem \else
                        \addpenalty\@beginparpenalty
                        \addvspace\@topsep \addvspace{-\parskip}\fi
           \else \addpenalty\@itempenalty \addvspace\itemsep
          \fi
    \global\@inlabeltrue
\fi
\everypar{\global\@minipagefalse\global\@newlistfalse
          \if@inlabel\global\@inlabelfalse \hskip -\parindent \box\@labels
             \penalty\z@ \fi
          \everypar{}}\global\@nobreakfalse
\if@noitemarg \@noitemargfalse \if@nmbrlist \refstepcounter{\@listctr}\fi \fi
\sbox\@tempboxa{\makelabel{#1}}%
\global\setbox\@labels
 \hbox{\unhbox\@labels \hskip \itemindent
       \hskip -\labelwidth \hskip -\ALC@tlm
       \ifdim \wd\@tempboxa >\labelwidth
                \box\@tempboxa
          \else \hbox to\labelwidth {\unhbox\@tempboxa}\fi
       \hskip \ALC@tlm}\ignorespaces}

\newenvironment{algorithmic}[1][0]{
\setcounter{ALC@depth}{\@listdepth}%
\let\@listdepth\c@ALC@depth%
\let\@item\ALC@item%
  \newcommand{\ALC@lno}{%
\ifthenelse{\equal{\arabic{ALC@rem}}{\@number{0}}}
{{\ALC@linenosize \arabic{ALC@line}\ALC@linenodelimiter}}{}%
}
\let\@listii\@listi
\let\@listiii\@listi
\let\@listiv\@listi
\let\@listv\@listi
\let\@listvi\@listi
\let\@listvii\@listi
  \newenvironment{ALC@g}{
    \begin{list}{\ALC@lno}{ \itemsep\z@ \itemindent\z@
    \listparindent\z@ \rightmargin\z@
    \topsep\z@ \partopsep\z@ \parskip\z@\parsep\z@
    \leftmargin \algorithmicindent%1em
    \addtolength{\ALC@tlm}{\leftmargin}
    }
  }
  {\end{list}}
  \newcommand{\ALC@it}{%
    \stepcounter{ALC@rem}%
    \ifthenelse{\equal{\arabic{ALC@rem}}{\@number{#1}}}{\setcounter{ALC@rem}{0}}{}%
    \stepcounter{ALC@line}%
    \refstepcounter{ALC@unique}%
    \item\def\@currentlabel{\theALC@line}%
  }
  \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{\AND}{\algorithmicand{} }
  \newcommand{\OR}{\algorithmicor{} }
  \newcommand{\XOR}{\algorithmicxor{} }
  \newcommand{\NOT}{\algorithmicnot{} }
  \newcommand{\TO}{\algorithmicto{} }
  \newcommand{\STATE}{\ALC@it}
  \newcommand{\STMT}{\ALC@it}
  \newcommand{\COMMENT}[1]{\algorithmiccomment{##1}}
  \newenvironment{ALC@inputs}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@outputs}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@globals}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@body}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@if}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@for}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@whl}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@loop}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@rpt}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@switch}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@case}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@otherwise}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@upon}{\begin{ALC@g}}{\end{ALC@g}}
  \newenvironment{ALC@proc}{\begin{ALC@g}}{\end{ALC@g}}
  \renewcommand{\\}{\@centercr}
  \newcommand{\INPUTS}[1][default]{\ALC@it\algorithmicinputs\ \ALC@com{##1}\begin{ALC@inputs}}
  \newcommand{\ENDINPUTS}{\end{ALC@inputs}}
  \newcommand{\OUTPUTS}[1][default]{\ALC@it\algorithmicoutputs\ \ALC@com{##1}\begin{ALC@outputs}}
  \newcommand{\ENDOUTPUTS}{\end{ALC@outputs}}
  \newcommand{\GLOBALS}{\ALC@it\algorithmicglobals\ }
  \newcommand{\BODY}[1][default]{\ALC@it\algorithmicbody\ \ALC@com{##1}\begin{ALC@body}}
  \newcommand{\ENDBODY}{\end{ALC@body}}
  \newcommand{\IF}[2][default]{\ALC@it\algorithmicif\ ##2\ \algorithmicthen%
\ALC@com{##1}\begin{ALC@if}}
  \newcommand{\ELSE}[1][default]{\end{ALC@if}\ALC@it\algorithmicelse%
\ALC@com{##1}\begin{ALC@if}}
  \newcommand{\ELSIF}[2][default]%
{\end{ALC@if}\ALC@it\algorithmicelsif\ ##2\ \algorithmicthen%
\ALC@com{##1}\begin{ALC@if}}
  \newcommand{\FOR}[2][default]{\ALC@it\algorithmicfor\ ##2\ \algorithmicdo%
\ALC@com{##1}\begin{ALC@for}}
  \newcommand{\FORALL}[2][default]{\ALC@it\algorithmicforall\ ##2\ %
\algorithmicdo%
\ALC@com{##1}\begin{ALC@for}}
  \newcommand{\WHILE}[2][default]{\ALC@it\algorithmicwhile\ ##2\ %
\algorithmicdo%
\ALC@com{##1}\begin{ALC@whl}}
  \newcommand{\LOOP}[1][default]{\ALC@it\algorithmicloop%
\ALC@com{##1}\begin{ALC@loop}}
  \newcommand{\REPEAT}[1][default]{\ALC@it\algorithmicrepeat%
\ALC@com{##1}\begin{ALC@rpt}}
  \newcommand{\UNTIL}[1]{\end{ALC@rpt}\ALC@it\algorithmicuntil\ ##1}
  \newcommand{\SWITCH}[2][default]{\ALC@it\algorithmicswitch\ ##2\ %
\ALC@com{##1}\begin{ALC@switch}}
  \newcommand{\CASE}[2][default]{\ALC@it\algorithmiccase\ ##2\ %
\ALC@com{##1}\begin{ALC@case}}
  \newcommand{\OTHERWISE}[1][default]{\ALC@it\algorithmicotherwise%
\ALC@com{##1}\begin{ALC@otherwise}}
  \newcommand{\UPON}[2][default]{\ALC@it\algorithmicupon\ ##2\ %
\algorithmicdo%
\ALC@com{##1}\begin{ALC@upon}}
  \newcommand{\PROC}[2][default]{\ALC@it\algorithmicproc\ ##2\ %
\ALC@com{##1}\begin{ALC@proc}}
  \ifthenelse{\boolean{ALC@noend}}{
    \newcommand{\ENDIF}{\end{ALC@if}}
    \newcommand{\ENDFOR}{\end{ALC@for}}
    \newcommand{\ENDWHILE}{\end{ALC@whl}}
    \newcommand{\ENDLOOP}{\end{ALC@loop}}
    \newcommand{\ENDSWITCH}{\end{ALC@switch}}
    \newcommand{\ENDCASE}{\end{ALC@case}}
    \newcommand{\ENDOTHERWISE}{\end{ALC@otherwise}}
    \newcommand{\ENDUPON}{\end{ALC@upon}}
    \newcommand{\ENDPROC}{\end{ALC@proc}}
  }{
    \newcommand{\ENDIF}{\end{ALC@if}\ALC@it\algorithmicendif}
    \newcommand{\ENDFOR}{\end{ALC@for}\ALC@it\algorithmicendfor}
    \newcommand{\ENDWHILE}{\end{ALC@whl}\ALC@it\algorithmicendwhile}
    \newcommand{\ENDLOOP}{\end{ALC@loop}\ALC@it\algorithmicendloop}
    \newcommand{\ENDSWITCH}{\end{ALC@switch}\ALC@it\algorithmicendswitch}
    \newcommand{\ENDCASE}{\end{ALC@case}\ALC@it\algorithmicendcase}
    \newcommand{\ENDOTHERWISE}{\end{ALC@otherwise}\ALC@it\algorithmicendotherwise}
    \newcommand{\ENDUPON}{\end{ALC@upon}\ALC@it\algorithmicendupon}
    \newcommand{\ENDPROC}{\end{ALC@proc}\ALC@it\algorithmicendproc}
  }
  \renewcommand{\@toodeep}{}
  \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%
\ifthenelse{\equal{#1}{0}}
  {\labelwidth 0.5em }
  {\labelwidth  1.2em }
\leftmargin\labelwidth \addtolength{\leftmargin}{\labelsep}
    \ALC@tlm\labelsep
  }
}
{\end{list}}