Хорошая практика для написания алгоритмов

Речь идет о том, как эффективно мы можем выразить алгоритм под рукой. Мне нужно это для моего обучения студентов.

Я понимаю, что нет такой вещи, как стандартный способ написания псевдокода. Разные авторы следуют различным соглашениям.

Было бы полезно, если бы люди указывали на то, как они следуют и считают лучшим.

Есть ли книга, которая имеет дело с этим в деталях?

Написание псевдокода похоже на написание кода: не очень важно, какой стандарт вы соблюдаете, если вы (и люди, с которыми вы пишете) действительно следует некоторому стандарту.

Но для справки, вот особенный стандарт, который я использую в своих конспектах лекций, исследовательских работах и ​​будущих книгах.

• Используйте стандартный императивный синтаксис для потока управления и доступа к памяти - если, пока, для, return, array [index], function (arguments). Разобрать "еще, если".

  • Но использование вместо или$field(record)$record.fieldrecord->field

• $xy$x*y$a\bmod b$a%b$s\le t$s <= t$\lnot p$!p$\sqrt{x}$sqrt(x)$\pi$PI$\infty$MAX_INT

  • Но используйте для назначения, чтобы избежать проблемы.$x\gets y$==

  • Но избегайте обозначений (и псевдокодов!) Полностью, если английский понятнее.

    • Симметрично, избегайте английского, если обозначения понятнее!

• Минимизируйте синтаксический сахар - укажите блочную структуру с помощью последовательного отступа (как на Python). Пропустите сладкие ключевые слова, такие как «начало / конец» или «do / od» или «fi». Опустить номера строк. Вы не подчеркнуть ключевые слова , как «за» или «а» или «если», установив их в другой typefaceили стиле . Когда-либо. Просто не надо.

  • Но набирайте имена алгоритмов и константы в \ textc {Small Caps}, имена переменных в курсиве и буквенные строки в sans serif.

  • Но добавьте небольшое количество вертикального «дышащего» пространства ( \\[0.5ex]) между значимыми кусками кода.

• Не указывайте неважные детали. Если не имеет значения, в каком порядке вы посещаете вершины, просто скажите «для всех вершин».

Например, вот рекурсивная формулировка алгоритма минимального связующего дерева Боровки . Ранее я определил как график, полученный из G путем сжатия всех ребер в множестве L , и Flatten как подпрограмму, которая удаляет петли и параллельные ребра.$G / L$$G$$L$

Я использую свою собственную облегченную algorithmсреду LaTeX для набора псевдокода. (Это просто tabbingсреда внутри \fbox.) Вот мой исходный код для алгоритма Боровки:

\begin{algorithm}
	\textul{$\textsc{Borůvka}(G)$:}\+
\\	if $G$ has no edges\+
\\		return $\varnothing$\-
\\[0.5ex]
	$L \gets \varnothing$
\\	for each vertex $v$ of $G$\+
\\		add the lightest edge incident to $v$ to $L$\-
\\[0.5ex]
	return $L \cup \textsc{Borůvka}(\textsc{Flatten}(G / L))$
\end{algorithm}

Я склонен использовать что-то похожее на синтаксис Python. Python уже достаточно близок к псевдокоду, и в некоторых случаях мой псевдокод может превратиться в реальный рабочий код.

Если вы хотите иметь определенный код (т. Е. Практически без математики, близкий к реальному программированию), вы можете подумать о том, чтобы иметь код, который фактически компилируется. Это имеет несколько преимуществ:

• Вы получаете подсветку синтаксиса везде.
• Компилятор проверяет синтаксис для вас и обеспечивает согласованность.
• Вы можете выполнить модульное тестирование своих реализаций, чтобы улучшить качество кода.
• Вы можете запустить алгоритм и сравнить измеренное время выполнения с анализом (таким образом мотивируя продвинутые методы анализа).

Профессор в моем университете делает это в своем курсе алгоритмов. Его язык выбора - Модула. Я не думаю, что конкретный выбор языка имеет значение, хотя. Просто придерживайтесь одного (на каждую парадигму), которое наилучшим образом соответствует вашему уровню абстракции.