Обсуждение:Дискретная математика и алгоритмы

Требования к написанию вики-конспектов 1 курса.

Главное

• Внимательно читайте свои конспекты перед тем, как совершать попытку их сдачи.
• Перед отправкой на проверку перечитайте эти требования.

Общение с редакторами

• Будет лучше, если вы зарегистрируетесь на сайте вики-конспектов и напишете в информации о себе имя, фамилию и группу.
• Не забывайте сообщать редакторам о том, что конспект нужно проверить.
• При общении с редактором, представляйтесь и указывайте какой конспект вы пишете. В теме письма указывайте “Вики-конспекты: Название вики-конспекта”.
• Ставить замечания к конспекту может не только ваш редактор, в том числе и после принятия конспекта. Их тоже надо учитывать.

Викификация

• Смотрите в качестве примера на конспекты, которые отмечены как хорошие.
• В конспекте не должно быть орфографических, пунктуационных, речевых, фактических, логических и других ошибок. Используйте spell checker.
• Используйте вики-шаблоны Шаблон: Определение, Шаблон: Теорема, Шаблон: Лемма, Шаблон: Утверждение (примеры использования смотрите в других конспектах).
• Приводите английские названия терминов, теорем, имен алгоритмов и т.д. Их лучше писать в скобках курсивом после их русских названий.
• Вместо черточки “-” используйте тире “—”. Для этого можно использовать Шаблон :---
• Редактировать можно не только свои конспекты — используйте “концепцию вики”
• Не используйте тег <br> . Для перевода строки в вики надо вставлять пустую строку.
• Ставьте категорию [[Категория: Дискретная математика и алгоритмы]] и подкатегорию с названием подтемы (например, [[Категория: Динамическое программирование]]). Список подкатегорий тут.

Источники

• Используйте ссылки на другие конспекты.
• В конспекте должны быть указаны источники или литература. Причем указывать ссылки не просто на википедию, а на конкретную статью(как Википедия - Экспоненциальная запись, на английскую — как Wikipedia - Scientific notation). Для книг достаточно указать автора, название, издание и номер страницы.

TeX

• Использование тега <tex> вместо <math> обязательно. Без тега tex можно писать только переменные сами по себе (a, b, n, i, T и т.д.) и названия функций в пояснениях к псевдокоду.
• Если лень постоянно писать <tex> </tex> , можно обернуть всю статью в <wikitex> </wikitex> , а потом обособлять формулы в $ $(например, <wikitex> Для любого $ \alpha $ верно $\sin^2 \alpha + \cos^2 \alpha = 1 $ </wikitex> ).
• Формулы с дробями нужно увеличивать для повышения читаемости, особенно, если их много в конспекте. Для этого используйте параметр dpi в теге tex. Пример: <tex dpi = "180">\frac {\omega_n(x)} {(x - x_j) \cdot \omega_n'(x_j)}</tex>

Псевдокод

(правила, в основном, отсюда Участник: Kirelagin/Оформление#Псевдокод)

• Используйте максимально компактный и читаемый псевдокод.
• Не ставьте фигурные скобки. Угадайте, для чего они нужны? Чтобы парсер языка было легче писать. Человеку они только мешают. Используйте отступы для группировки. (Python-style)
• Не ставьте круглые скобки вокруг внешнего условия if'а, while'а и т.п.
• Обозначайте присвоение нормально, с помощью знака «=», а сравнение как «==» (всё равно придётся слезать с паскаля).
• Не вводите какие-то левые операторы. Например, если кладёте что-то в очередь, так и напишите: q.push(a).
• TeX в псевдокоде можно использовать только в случае какого-то нестандартного оператора(а перед этим хорошо подумать и посмотреть предыдущий пункт)
• Обычные правила хорошего кода:
  • Ставим пробелы между операндами и бинарными операторами(«1 + 2», а не «1+2»). После унарных операторов перед операндом пробел ставить не нужно.
  • Не ставим пробел перед скобкой - вызовом функции(«f(x)», а не «f (x)»)
  • Разделяем аргументы функции запятой
  • Используем какой-то определённый стиль именования переменных(я бы рекомендовал lowerCamelCase для переменных и функций и UpperCamelCase для классов)