Алгоритмы и листинги исходного кода

Набросок в algorithm2e и listings для настоящего кода.

Алгоритмы и листинги исходного кода

В статьях код представляют в двух разных видах, и для каждого в LaTeX есть свой инструмент. Псевдокод — это идеализированный набросок алгоритма, набранный ключевыми словами и формулами, и им занимается пакет algorithm2e. Листинги исходного кода — это настоящий код, воспроизведённый дословно моноширинным шрифтом, и их набирает пакет listings. Неверный выбор инструмента — обычный источник трудностей, поэтому полезно увидеть оба.

Псевдокод в algorithm2e

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

Параметры пакета задают оформление: ruled проводит горизонтальные линии над алгоритмом и под ним и ставит подпись сверху, как принято в большинстве изданий, а vlined рисует небольшую вертикальную линию вдоль каждого блока, так что вложенность читается без глубоких отступов. Среда algorithm — это плавающий объект, как рисунок, поэтому в ней есть \caption, который присваивает алгоритму номер для ссылок через \ref.

Внутри \While{condition}{body} набирает цикл: ключевое слово полужирным, условие и тело в виде блока с отступом. \For, \If и \Return устроены так же. Операторы заканчиваются на \;, что печатает завершающий символ строки и начинает новую строку. Забыть его — классическая ошибка новичков: строки сливаются. Это обычный LaTeX, поэтому формулы вроде $\theta$ работают прямо в строке, а ради этого псевдокод и нужен: описывать правило обновления в нотации, а не на каком-то конкретном языке.

Настоящий код в listings

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

Среда lstlisting воспроизводит своё содержимое в точности: сохраняет пробелы и воспринимает специальные символы буквально, так что код можно вставлять, ничего не экранируя. Параметр language=Python включает подсветку ключевых слов этого языка, а listings знает ещё десятки других. По умолчанию вывод простой. Большинство один раз добавляют в преамбулу \lstset{basicstyle=\ttfamily\small, numbers=left}, чтобы получить моноширинный шрифт разумного размера и нумерацию строк. Чтобы подключить файл целиком, а не вставлять текст, используйте \lstinputlisting[language=Python]{train.py}: он читает файл с диска, и статья всегда соответствует реальному исходнику. Если нужна цветная подсветка высокого качества, сильнее подойдёт пакет minted, но ценой внешнего инструмента и shell escape.

Что выбрать

Используйте псевдокод в основном тексте статьи, чтобы передать идею, а дословные листинги оставьте для материалов, где важен точный код, например для приложений или описаний инструментов. Частая ошибка — поместить lstlisting внутрь кадра Beamer без параметра [fragile]: компиляция падает с непонятной ошибкой. Та же оговорка есть в первой презентации Beamer.

Вернуться к Наборы по областям