Структура описания метода
Данная страница - проект одной из инструкций для редакторов АлгоВики. В настоящее время инструкция ещё не утверждена. |
Данный документ содержит описание схемы, по которой предлагается описывать свойства метода.
В тех случаях, если алгоритмическая реализация метода всего одна, метод следует описывать по схеме, изложенной в Структуре описания свойств алгоритмов. Данная же схема должна применяться для описания методов, у которых есть разные реализующие их алгоритмы.
Если описываемый метод решения задачи по сути состоит из отдельных частей, решающих более мелкие подзадачи, то вместо детального изложения можно просто указать на это, с надлежащими ссылками на описание этих методов (алгоритмов) решения подзадач.
В случаях, не сводимых к ранее перечисленным, предлагается следовать следующей последовательности.
В начале описания метода следует описать решаемую им задачу. При этом, однако, не следует делать описание задачи излишне подробным: для этого будет предназначено её "собственное" описание с помощью Структуры описания задачи на отдельной странице АлгоВики.
После описания задачи следует отдельным пунктом изложить математические основы самого метода, общие для всех реализующих его алгоритмов.
Далее следует отдельными пунктами дать краткие описания отдельных алгоритмов, с выделением их собственных главных особенностей. Если один из алгоритмов был придуман первым, то его описание, как классического варианта, может быть более подробным, например, математические основы метода могут быть описаны в пункте, посвящённом именно классическому варианту. При описании отдельных алгоритмов желательно изложение структурировать, классифицируя варианты каким-либо естественным математическим способом. В конце изложения желательно сопоставление вариантов по разным параметрам (как параллельным, так и простым вычислительным).
В случае наличия страниц описаний разных вариантов метода обязательно указание на них в соответствующих пунктах описания метода. Аналогично, в описаниях алгоритмов желательно наличие ссылки на описание объединяющего их метода.