Гарні практики написання алгоритмів

Мова йде про те, наскільки ефективно ми можемо виразити алгоритм. Мені це потрібно для моєї студентської викладання.

Я розумію, що немає такого поняття, як стандартний спосіб написання псевдокоду. Різні автори дотримуються різних умов.

Було б корисно, якби тут люди зазначили, спосіб, яким вони слідують і вважають найкращим.

Чи є якась книга, яка детально розглядає це?

Написання псевдокоду схоже на написання коду: Це не особливо важливо, якого стандарту ви дотримуєтесь, якщо ви (і люди, з якими ви пишете) насправді дотримуєтесь певного стандарту.

Але для запису, ось ідіосинкратичний стандарт, який я використовую в своїх лекційних записках, науково-дослідних роботах та новій книзі.

• Використовуйте стандартний синтаксис імперативу для контролю потоку та доступу до пам'яті - if, while, for, return, array [index], function (аргументи). Пропишіть "ще якщо".

  • Але використовуйте замість або$field(record)$record.fieldrecord->field

• Використовуйте стандартні математичні позначення для математики - Запис замість того , в модах б замість , s ≤ т замість того , ¬ р замість , $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$==

  • Але уникайте позначень (і псевдокоду!) Повністю, якщо англійська зрозуміліша.

    • Симетрично уникайте англійської мови, якщо позначення чіткіші!

• Мінімізуйте синтаксичний цукор - Вкажіть структуру блоку за допомогою послідовного відступу (à la Python). Пропустіть цукристі ключові слова, такі як "початок / кінець" або "до / од" або "фі". Пропустіть номери рядків. Ви НЕ підкреслити ключові слова , як «за» або «а» або «якщо», встановивши їх в інший typefaceабо стилі . Колись. Просто ні.

  • Але імена та константи алгоритму набору в \ textc {Small Caps}, назви змінних курсивом та літеральні рядки в sans serif.

  • Але додайте невелику кількість вертикального "дихаючого" простору \\[0.5ex]між значущими фрагментами коду.

• Не вказуйте неважливі деталі. Якщо не має значення, в якому порядку ви відвідуєте вершини, просто скажіть "для всіх вершин".

$G / L$$G$$L$

Я використовую власне полегшене algorithmсередовище LaTeX для набору псевдокоду. (Це просто tabbingсередовище всередині \fbox.) Ось мій вихідний код алгоритму Borůvka:

\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 достатньо близький до псевдокоду, що в деяких випадках мій псевдокод може затінити фактичний робочий код.

Якщо ви хочете мати певний код (тобто мало-мало математики, близький до реального програмування), ви можете розглянути можливість наявності коду, який насправді компілюється. Це має ряд переваг:

• Ви підсвічуєте синтаксис скрізь.
• Компілятор перевіряє для вас синтаксис і застосовує послідовність.
• Для покращення якості коду ви можете протестувати свої реалізації.
• Можна запустити алгоритм і порівняти вимірювані тривалість виконання з аналізами (таким чином мотивуючи передові методи аналізу).

Професор мого університету робить це у своєму курсі алгоритмів. Мовою вибору є модуль. Я не думаю, що особливий вибір мови має значення. Просто дотримуйтесь однієї (за парадигмою), яка найкраще відповідає вашому рівню абстракції.