1.3.5.1 サンプル関数の説明¶
関数の説明では、説明されている関数の名前が最初に表示されます。その後に同じ行にパラメータのリストが続きます。パラメータに使用される名前は、説明の本文でも使用されます。
すべての呼び出し形式が列挙された後、次の行は関数の簡潔な 1 文の要約になります。
要約の後には、入力と出力に関するドキュメント、関数の使用例、使用したアルゴリズムに関するメモ、および関連する関数への参照が含まれる場合があります。
虚数関数fooの説明は次のとおりです。
: foo (x)
: foo (x, y)
: foo (x, y, …)
yからxを減算し、残りの引数を結果に追加します。
入力x は数値スカラー、ベクトル、または配列である必要があります。
オプションの入力y は、指定されていない場合はデフォルトで 19 になります。
例：
foo (1, [3, 5], 3, 9)
⇒ [ 14, 16 ]
foo (5)
⇒ 14
より一般的には
foo (w, x, y, ...) ≡ x - w + y + ... See also: bar
名前に型名 (例: integerまたはmatrix ) が含まれるパラメータは、その型であることが想定されます。objectという名前のパラメータは、任意の型にすることができます。他の種類の名前 (例: new_file ) を持つパラメータについては、関数の説明で具体的に説明します。一部のセクションでは、複数の関数のパラメータに共通する機能が最初に説明します。