Algorithmen und Quelltext-Listings

algorithm2e für Pseudocode und listings für echten Code.

Algorithmen und Quelltext-Listings

Artikel zeigen Code in zwei verschiedenen Formen, und LaTeX hat für jede ein eigenes Werkzeug. Pseudocode ist eine idealisierte Skizze eines Algorithmus, gesetzt mit Schlüsselwörtern und Mathematik, und das Paket algorithm2e übernimmt ihn. Quelltext-Listings sind echter Code, der wortgetreu in einer Festbreitenschrift wiedergegeben wird, und das Paket listings übernimmt diese. Das falsche Werkzeug zu wählen ist die übliche Quelle von Reibung, daher hilft es, beide zu kennen.

Pseudocode mit algorithm2e

\usepackage[ruled,vlined]{algorithm2e}
\begin{algorithm}
\caption{Train}
\While{not converged}{
Update $\theta$\;
}
\end{algorithm}

Die Paketoptionen bestimmen den optischen Stil: ruled zeichnet waagerechte Linien über und unter den Algorithmus und setzt die Beschriftung nach oben, wie es die meisten Tagungen und Zeitschriften erwarten, während vlined eine kleine senkrechte Linie zeichnet, die den Umfang jedes Blocks markiert, sodass die Verschachtelung ohne tiefe Einrückung lesbar bleibt. Die Umgebung algorithm ist wie eine Abbildung ein Float, daher trägt sie die \caption, die ihr eine Nummer gibt, auf die \ref verweisen kann.

Darin setzt \While{condition}{body} die Schleife mit einem fetten Schlüsselwort, der Bedingung und dem Rumpf als eingerücktem Block. \For, \If und \Return folgen demselben Muster. Anweisungen enden mit \;, das den Zeilenabschluss ausgibt und eine neue Zeile beginnt. Das zu vergessen ist der klassische Anfängerfehler: Die Zeilen laufen ineinander. Weil es gewöhnliches LaTeX ist, funktioniert Mathematik wie $\theta$ im Text, und genau dafür ist Pseudocode da: die Aktualisierungsregel in Notation zu beschreiben statt in einer bestimmten Sprache.

Echter Code mit listings

\usepackage{listings}
\begin{lstlisting}[language=Python]
def f(x):
return x**2
\end{lstlisting}

Die Umgebung lstlisting gibt ihren Inhalt exakt wieder, erhält Leerraum und behandelt Sonderzeichen wörtlich, sodass Sie Code einfügen können, ohne etwas zu maskieren. Die Option language=Python schaltet die Hervorhebung von Schlüsselwörtern für diese Sprache ein, und listings kennt Dutzende weitere. Standardmäßig ist die Ausgabe schlicht. Die meisten fügen einmalig in der Präambel \lstset{basicstyle=\ttfamily\small, numbers=left} ein, um eine Festbreitenschrift in vernünftiger Größe mit Zeilennummern zu erhalten. Um eine Datei direkt einzubinden, statt sie einzufügen, liest \lstinputlisting[language=Python]{train.py} sie von der Festplatte, wodurch der Artikel mit dem tatsächlichen Quelltext synchron bleibt. Wenn Sie eine farbige, hochwertige Hervorhebung möchten, ist das Paket minted die stärkere Alternative, allerdings um den Preis eines externen Werkzeugs und der Shell-Escape-Funktion.

Zwischen beiden wählen

Verwenden Sie Pseudocode im Hauptteil des Artikels, um die Idee zu vermitteln, und heben Sie wortgetreue Listings für Stellen auf, an denen der genaue Code zählt, etwa Anhänge oder Werkzeugbeschreibungen. Ein häufiger Fehler ist, eine lstlisting ohne die Option [fragile] in einen Beamer-Frame zu setzen, was mit einem undurchsichtigen Fehler scheitert; dieselbe Warnung steht in Ihre erste Beamer-Präsentation.

Zurück zu Feldkits