Алгоритми та лістинги коду

Начерк алгоритму в algorithm2e і listings для реального коду.

Алгоритми та лістинги коду

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

Псевдокод з algorithm2e

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

Параметри пакета задають візуальний стиль: ruled малює горизонтальні лінії над алгоритмом і під ним та ставить підпис угорі, як того очікує більшість конференцій і журналів, а vlined малює невелику вертикальну лінію, що позначає межі кожного блока, тож вкладеність лишається читабельною без великих відступів. Середовище algorithm — це float, як і рисунок, тому в ньому є \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.

Назад до Набори для галузей