[Tex/LaTex] Which package to use for writing algorithms

algorithmscodelistingspseudocode

I am looking for a package that will allow me to write pseudocode
of algorithms. The pseudocode may include mathematical symbols, like
\forall, \in and subscripts. But I would like also to "talk" about
variables contained in the pseudocode in my text, so be able to say "In figure …
variable foobar corresponds .." and make the word foobar have the same appearance
as in the pseudocode example.

I found that with the listings package
I can add mathematical symbols by using: \begin{lstlisting}[mathescape]. The problem
with this package is that I don't know how to make just one word have the
same appearance as the words appearing inside \begin{lstlisting} ... \end{lstlisting}.

Any ideas how to do this?
Or perhaps of another package that will help solve the above
mentioned problem?

Best Answer

The lstlisting environment is part of the “listings” package.

Additionally to providing an environment for listings (\begin{lstlisting}) and a command to import code from files (\lstinputlisting), it also provides a command to highlight code inline: \lstinline.

Be aware, that \lstinline has some limitations though (and does not obay all options from lstset)

Related Solutions

[Tex/LaTex] a good package for displaying algorithms

Personally, I favour algpseudocode from the algorithmicx (note the trailing x!) package. With a bit of setup, this can be harnessed to create beautiful pseudocode.

algpseudocode example

This was produced by the following code:

\begin{algorithm}
  \caption{Counting mismatches between two packed \DNA{} strings
    \label{alg:packed-dna-hamming}}
  \begin{algorithmic}[1]
    \Require{$x$ and $y$ are packed \DNA{} strings of equal length $n$}
    \Statex
    \Function{Distance}{$x, y$}
      \Let{$z$}{$x \oplus y$} \Comment{$\oplus$: bitwise exclusive-or}
      \Let{$\delta$}{$0$}
      \For{$i \gets 1 \textrm{ to } n$}
        \If{$z_i \neq 0$}
          \Let{$\delta$}{$\delta + 1$}
        \EndIf
      \EndFor
      \State \Return{$\delta$}
    \EndFunction
  \end{algorithmic}
\end{algorithm}

And used the following setup (this is just an example to replicate the above; you can of course use your own setup):

\usepackage{fontspec}
\setmainfont{Hoefler Text}
\newcommand*\DNA{\textsc{dna}}

\newcommand*\Let[2]{\State #1 $\gets$ #2}
\algrenewcommand\alglinenumber[1]{
    {\sf\footnotesize\addfontfeatures{Colour=888888,Numbers=Monospaced}#1}}
\algrenewcommand\algorithmicrequire{\textbf{Precondition:}}
\algrenewcommand\algorithmicensure{\textbf{Postcondition:}}

To get the end-less pseudocodes, I included the package as follows:

\usepackage[noend]{algpseudocode}

The above pseudo code is nested inside an algorithm float environment. This environment isn’t part of algorithmicx. Instead, you need to load the package algorithm to get it. To produce a list of all algorithms, you can use

\listofalgorithms

For further information, see the section “The algorithm Environment” in the documentation of the algorithms package. But I want to stress again that (except for the float environment) the algorithmicx package is superior to algorithms.

[Tex/LaTex] Rename “Algorithm” to “Listing”

Solution

Do not mix lst: with Algorithm floats. The previous solution used \newcommand{\algorithmname}{Listing}, but this could result in LaTeX Error: Command \algorithmname already defined. Instead, apply the following changes:

Rename lst: to alg:.

Change the preamble to:

\usepackage{float}
\floatname{algorithm}{Listing}
\renewcommand{\algorithmname}{Listing}

This does not change the "List of Algorithms" to "List of Listings". The text is found in "stdfloats.inc":

Float
    Type                  algorithm
    GuiName               Algorithm
    Placement             tbp
    Extension             loa
    NumberWithin          none
    Style                 ruled
    ListName              "List of Algorithms"
    LaTeXBuiltin          false
End

The improper way to fix this is:

Edit stdfloats.inc.
Change "List of Algorithms" to "List of Listings".
Click Tools >> Reconfigure.
Restart LyX.

At this point, "List of Algorithms" will read "List of Listings".

Best Answer

Related Solutions

[Tex/LaTex] a good package for displaying algorithms

[Tex/LaTex] Rename “Algorithm” to “Listing”

Solution

Related Question