[Tex/LaTex] Parameter section similar to Input and Output

algorithm2e

I would like to create a "Parameter: …" section, similar to the "Input: …" and "Output: …" sections in my algorithm description. The parameters are global, user-defined constants, known before the algorithm is run.

I have tried to define a new keyword with the text "Parameter" but of course that does the wrong thing (among others: the line is numbered but it should not be, everything behind the "Parameter:" is in italics but I don't want it to be).

How can I create a parameter section similar to Input and Output?

Gonzalo Medina's answer almost does the right thing but I get a superfluous colon on a separate line.

enter image description here

Code:

\documentclass[preprint,3p,12pt,times]{elsarticle}
\usepackage{ecrc}
\usepackage[linesnumbered,algoruled,boxed,lined]{algorithm2e}
\volume{00}
\firstpage{1}
\journalname{Some journal}

% Would work correctly with these lines:
% \documentclass{article}
% \usepackage[linesnumbered,algoruled,boxed,lined]{algorithm2e}

\SetKwInOut{Parameter}{Parameters}

\begin{document}

\begin{algorithm}[H]
  \KwIn{Some input}
  \Parameter{Some parameter}
  \KwOut{Some output}    
\caption{Some algorithm}\label{alg.mainLoop}
\end{algorithm}

\end{document}

I guess it is some macro clash among the packages. Any workaround would be greatly appreciated.

Best Answer

You can use

\SetKwInOut{Parameter}{parameter}

and then

\Parameter{<text>}

in you algorithms. A complete example:

\documentclass{article}
\usepackage{algorithm2e}

\SetKwInOut{Parameter}{parameter}

\begin{document}

\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}
\Parameter{A parameter for the algorithm}
\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*[r]{\This linked to \Up}\label{lelse}
}
}
\lForEach{element $e$ of the line $i$}{\FindCompress{p}}
}
\caption{disjoint decomposition}\label{algo_disjdecomp}
\end{algorithm}

\end{document}

enter image description here

After the edit to the question, there's some incompatibility between elsarticle and the new definition; in this case, you can move the new definition inside the algorithm environment which can be done on a on-per-one basis or, as Werner suggested in his comment, can be automated using

\makeatletter 
\g@addto@macro{\@algocf@init}{\SetKwInOut{Parameter}{Parameters}} 
\makeatother

A complete example:

\documentclass[preprint,3p,12pt,times]{elsarticle}
\usepackage[linesnumbered,algoruled,boxed,lined]{algorithm2e}

\makeatletter 
\g@addto@macro{\@algocf@init}{\SetKwInOut{Parameter}{Parameters}} 
\makeatother

\begin{document}

\begin{algorithm}[H]
\KwIn{Some input}
\Parameter{Some parameter}
\KwOut{Some output}    
\caption{Some algorithm}\label{alg.mainLoop}
\end{algorithm}

\end{document}

enter image description here

Related Solutions

[Tex/LaTex] How to create a list in algorithm input

There are different possibilities; it all depends on what you want. Here are some possibilities.

\documentclass[letterpaper,twocolumn,10pt]{article}
\usepackage{algorithm2e}
\begin{document}
\begin{algorithm}[]
 \SetKwData{Left}{left}\SetKwData{This}{this}\SetKwData{Up}{up}%
 \SetKwFunction{Union}{Union}\SetKwFunction{FindCompress}{FindCompress}%
 \SetKwInOut{Input}{input}\SetKwInOut{Output}{output}%
 \Input
  {\begin{minipage}[t]{6cm}%
     \strut
     $(a_i,b_i)$, $(a_{i+1},b_{i+1})$, \dots\ tuples for
     start-end etc etc etc etc etc etc etc etc

     $(c_i,d_i)$, $(c_{i+1},d_{i+1})$, \dots\ tuples for
     start-end etc etc etc etc etc etc etc etc
     \strut
   \end{minipage}%
  }
 \Output{A partition of the bitmap}
 \BlankLine
 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}
\end{document}

 \Input
  {\begin{itemize}
   \item $(a_i,b_i)$, $(a_{i+1},b_{i+1})$, \dots\ tuples for
     start-end etc etc etc etc etc etc etc etc
   \item $(c_i,d_i)$, $(c_{i+1},d_{i+1})$, \dots\ tuples for
     start-end etc etc etc etc etc etc etc etc
   \end{itemize}%
  }

 \Input
  {\begin{itemize}
   \item[] $(a_i,b_i)$, $(a_{i+1},b_{i+1})$, \dots\ tuples for
     start-end etc etc etc etc etc etc etc etc
   \item[] $(c_i,d_i)$, $(c_{i+1},d_{i+1})$, \dots\ tuples for
     start-end etc etc etc etc etc etc etc etc
   \end{itemize}%
  }

 \Input
  {\par
   $(a_i,b_i)$, $(a_{i+1},b_{i+1})$, \dots\ tuples for
     start-end etc etc etc etc etc etc etc etc
   \par
   $(c_i,d_i)$, $(c_{i+1},d_{i+1})$, \dots\ tuples for
     start-end etc etc etc etc etc etc etc etc
  }

[Tex/LaTex] ShareLatex – Error on import/include a .tex with algorithm2e into another .tex with prosa

I now am using the following workaround (i call it that way because it causes circumstances).

ever algorithm has its own tex file but without any preamble and without includes etc.
this way I cannot compile these files directly but need another tex using \input and all neccessary includes to compile this file
- this is cumbersome because I always need to change the tex for compiling when just changed a little on the pseudo-code

this way my code-tex is looking like this:

\begin{algorithm}
...
\end{algorithm

these "wrapper-tex" is looking like this:

\documentclass[12pt, letterpaper]{article}
\usepackage[utf8]{inputenc}
\usepackage{import}

\usepackage{amsmath}
\usepackage{amsfonts}
\usepackage[linesnumbered,ruled]{algorithm2e}

\begin{document}

\import{Algo}{MyAlgo.tex}

\end{document}

For not getting the line pitch of the surrounding document I use \renewcommand before unsing input on the code and after it again to setting it back. When the code does not fit into the line latex display text, which actually occurs after the input, before the code itself (on the previous page if theres enough space left for text but not for code). I got it by adding a \newpage after the input of the code.

Using include does not show my pseudo code at all. My include that way looks like:

\begin{flushleft}

some text
...
again some text

\renewcommand{\baselinestretch}{1.0}

\input{Algo/MyAlog.tex}

\renewcommand{\baselinestretch}{1.5}


\newpage

againagainsometext
...
u know
\end{flushleft}
...

I had also problems because in the tex with my texts I defined 12pt fontsize while I didn at first on my code-wrapper. The pseudocode that way was enlarged after inputting it. Resizing it using recommendations of these Reduce pseudocode font size (not global) or othere did not help very much, I surrendered after over an hour trying so I reduced my pseudocode by dividing it into multiple/ separate algorithms and by deleting code commentary.

Best Answer

Related Solutions

[Tex/LaTex] How to create a list in algorithm input

[Tex/LaTex] ShareLatex – Error on import/include a .tex with algorithm2e into another .tex with prosa

Related Question