Algorithmes et listings de code
Esquisse avec algorithm2e et listings pour le vrai code.
Algorithmes et listings de code
Les articles présentent du code sous deux formes distinctes, et LaTeX a un outil différent pour chacune. Le pseudocode est une esquisse idéalisée d’un algorithme, composée de mots-clés et de mathématiques, et c’est l’extension algorithm2e qui s’en charge. Les listings de code sont du vrai code reproduit tel quel dans une police à chasse fixe, et c’est l’extension listings qui s’en charge. Choisir le mauvais outil est la source habituelle des difficultés ; il est donc utile de voir les deux.
Pseudocode avec algorithm2e
\usepackage[ruled,vlined]{algorithm2e}\begin{algorithm}\caption{Train}\While{not converged}{ Update $\theta$\;}\end{algorithm}Les options de l’extension fixent le style visuel : ruled trace des filets horizontaux au-dessus et au-dessous de l’algorithme et place la légende en haut, convention attendue par la plupart des conférences et revues, tandis que vlined trace un petit trait vertical qui marque l’étendue de chaque bloc, de sorte que l’imbrication reste lisible sans forte indentation. L’environnement algorithm est un flottant, comme une figure : il porte donc le \caption qui lui donne un numéro que \ref peut citer.
À l’intérieur, \While{condition}{body} compose la boucle avec un mot-clé en gras, la condition, puis le corps sous forme de bloc en retrait. \For, \If et \Return suivent le même schéma. Les instructions se terminent par \;, qui imprime le terminateur de la ligne et passe à la ligne suivante. L’oublier est l’erreur classique du débutant : les lignes se collent les unes aux autres. Comme il s’agit de LaTeX ordinaire, les mathématiques comme $\theta$ fonctionnent dans le texte, et c’est à cela que sert le pseudocode : décrire la règle de mise à jour en notation mathématique plutôt que dans un langage précis.
Du vrai code avec listings
\usepackage{listings}\begin{lstlisting}[language=Python]def f(x): return x**2\end{lstlisting}L’environnement lstlisting reproduit son contenu à l’identique : il conserve les espaces et traite les caractères spéciaux littéralement, ce qui permet de coller du code sans rien échapper. L’option language=Python active la coloration des mots-clés pour ce langage, et listings en connaît des dizaines d’autres. Par défaut, le rendu est simple. La plupart des gens ajoutent une fois pour toutes un \lstset{basicstyle=\ttfamily\small, numbers=left} dans le préambule pour obtenir une police à chasse fixe d’une taille raisonnable, avec des numéros de ligne. Pour inclure directement un fichier au lieu de coller son contenu, \lstinputlisting[language=Python]{train.py} le lit sur le disque, ce qui garde l’article synchronisé avec le code source réel. Si vous voulez une coloration en couleurs de haute fidélité, l’extension minted est l’alternative la plus puissante, au prix d’un outil externe et de l’option shell escape.
Choisir entre les deux
Utilisez le pseudocode dans le corps de l’article pour communiquer l’idée, et réservez les listings à l’identique aux cas où le code exact compte, comme les annexes ou les descriptions d’outils. Une erreur fréquente consiste à placer un lstlisting dans une diapositive Beamer sans l’option [fragile], ce qui échoue avec une erreur peu parlante ; la même mise en garde figure dans un premier diaporama Beamer.