1.3.5.1 Описание примера функции

В описании функции имя описываемой функции указывается первой. За ним в той же строке следует список параметров. Имена, используемые для параметров, также используются в теле описания.

После перечисления всех форм вызова следующая строка содержит краткое однопредложное резюме функции.

После резюме могут быть документация по входным и выходным данным, примеры использования функции, заметки об используемом алгоритме и ссылки на связанные функции.

Вот описание воображаемой функции foo:

: foo (x) ¶

: foo (x, y) ¶

: foo (x, y, …) ¶

Вычитает x из y, а затем добавляет все оставшиеся аргументы к результату.

Входной параметр x должен быть числовым скаляром, вектором или массивом.

Необязательный входной параметр y по умолчанию равен 19, если он не указан.

Пример:

foo (1, [3, 5], 3, 9)
     ⇒ [ 14, 16 ]
foo (5)
     ⇒ 14

В более общем случае,

foo (w, x, y, …)
≡
x - w + y + …

См. также: bar

Любой параметр, имя которого содержит имя типа (например, integer или matrix), ожидается как соответствующего типа. Параметры с именем object могут быть любого типа. Параметры с другими типами имен (например, new_file) обсуждаются в описании функции. В некоторых разделах в начале описываются общие особенности параметров нескольких функций.