[Tex/LaTex] Defining a new keyword in algorithm2e

algorithm2e

I'm trying to define a new keyword for my algorithm:

\documentclass{article}
\usepackage[]{algorithm2e}
\begin{document}
\SetKw{kwInit}{Init:}
\begin{algorithm}
\kwInit{$\alpha_n=1$ for all $n$}
\While{not at end of this document}{
do this and that
}
\end{algorithm}
\end{document}

The problem is the colon after Init is not automatically generated and I have to define it like this {Init:} which will generate a bold colon instead of a normal one. How to fix this?
Also, the argument "for all n" will be italic and immediately followed by "while" of the next line. How can I fix this?

Thanks.

Best Answer

Sounds like you are after \SetKwInput, with syntax

\SetKwInput{<name>}{<keymord>}

which defines the macro \<name>{<arg>} to print <keyword> in keyword typography followed by :, and then argument <arg>.

A complete example:

\documentclass{article}
\usepackage[]{algorithm2e}

\SetKwInput{kwInit}{Init}

\begin{document}
\begin{algorithm}
\kwInit{$\alpha_n=1$ for all $n$}
\While{not at end of this document}{
do this and that
}
\end{algorithm}
\end{document}

The result:

enter image description here

Related Solutions

[Tex/LaTex] Help with algorithm2e formatting

Supposing your document is in German , loading babel with german set via document class does the trick. To replace end with endfor, overwrite the definition of For with \SetKwFor:

\documentclass[german] {article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{babel} \usepackage[linesnumbered, ruled, vlined]{algorithm2e}

\SetKwFor{For}{for}{do}{endfor for}%

\begin{document}

\SetAlgoNoLine
\begin{algorithm}[H]
  \DontPrintSemicolon
  \KwIn{$X_{t-1}, u_t · z_t$}
  \KwOut{$X_t$}
  $\overline{X_t} = X_t = 0$\;
  \For{$k = 1$ to $M$}{
    $x^{[k]}_t = sample\_motion\_model(u_t, x^{[k]}_{t-1})$\;
    $w^{[k]}_t = measurement\_model(z_t, x^{[k]}_t, m_{t-1})$\;
    $m^{[k]}_t = updated\_occupancy\_grid(z_t, x^{[k]}_t, m^{[k]}_{t-1})$\;
    $\overline{X_t} = \overline{X_t} + \langle x_x^{[m]}, w_t^{[m]} \rangle $\;
  }
  \For {$k = 1$ to $M$}{
    draw $ i $ with probability $\approx w_t^{[i]}$\;
    add $\langle x_x^{[m]}, w_t^{[m]} \rangle$ to $X_t$\;
  }
  \Return $X_t$
  \caption{FastSLAM}
\end{algorithm}

\end{document}

[Tex/LaTex] Trying to write `loop`keyword in algorithm2e

I am now discovering this package and in the documentation, there are macros that allow you to define your own keywords.

There are some that define loops, but they add the stop test either at the end or at the beginning of the loop.

So I opted for the macro that defines a block, since the stop test is given before the end of the loop. \SetKwBlock{Loop}{Loop}{end}

The first parameter defines the name of the macro, so if you write it with a capital letter {Loop}, you must do the same when calling: \Loop. If you write it with a lower case {loop}, you must call \loop. The second parameter is how the keyword will be displayed in the algorithm.

I quote the manual on page 35:

\SetKwBlock{Begin}{begin}{end} defines a macro \Begin{txt} which denotes a block. The text is surrounded by the words begin and end in keyword typography and shifted to the right (indented). In \Vline or \Line mode a straight vertical line is added. \Begin(side text){text} gives also text in a block surrounded by begin and end, but side text if put after the begin keyword. Combined with \tcc*[f] macro, it allows you to put comments on the same line as begin. You can also use alternativ \uBegin{txt} which acts as \Begin{txt} but without end. Useful for example as a part separator that doesn't necessary need an end keyword.

\documentclass{article}
\usepackage{xcolor}
\usepackage[linesnumbered,boxruled,ruled,noline]{algorithm2e}



%%% Coloring the comment as blue
\newcommand\mycommfont[1]{\footnotesize\ttfamily\textcolor{blue}{#1}}
\SetCommentSty{mycommfont}

\SetKwInput{KwInput}{Input}                % Set the Input
\SetKwInput{KwOutput}{Output}              % set the Output
\SetKwBlock{Loop}{Loop}{end}
\begin{document}
%\maketitle

\begin{algorithm}[H]
\DontPrintSemicolon

  \KwInput{Your Input}
  \KwOutput{Your output}
  \KwData{Testing set $x$}
  \Loop ( until the terminal condition is met. One epoch:)
  {n=n+1

  $\sum_{i=1}^{\infty} := 0$ \tcp*{this is a comment}
  \tcc{Now this is an if...else conditional loop}
  \If{Condition 1}
    {
        Do something    \tcp*{this is another comment}
        \If{sub-Condition}
        {Do a lot}
    }

   terminal condition: RMSE on \dots
}
\caption{Example code}
\end{algorithm}

\end{document}

Best Answer

Related Solutions

[Tex/LaTex] Help with algorithm2e formatting

[Tex/LaTex] Trying to write `loop`keyword in algorithm2e

Related Question