目的 | 簡単な説明を与える。 |
形式 | 関数の書式を示す。 |
詳細 | 関数は何をするためのものなのか, またどのような規則や制約があるのかを説明する。 |
算法 | 関連するアルゴリズムとルーチンを示す。 |
例題 | 関数の使用例を示す。 |
文献 | 参考文献等の資料。 |
参照 | 関連する関数の参照。 |
形式の表記法について説明する。関数abs()の形式を次に示す。
y = abs(x) Y = abs(X) (Integer|Real|Real) y; (Matrix|Array|Index) Y; (Integer|Real|Complex) x; (Matrix|Array|Index) X; y = abs(s) Matrix y; String s;関数abs()には,大まかな形式が3種類ある。 1番目の形式
y = abs(x) (Integer|Real|Real) y; (Integer|Real|Complex) x;はスカラ型に関する形式で,整数(Integer)が引数のとき整数を, 実数が引数のとき実数を,複素数が引数のとき実数をそれぞれ返すことを意味する。 同様に,2番目の形式
Y = abs(X) (Matrix|Array|Index) Y; (Matrix|Array|Index) X;は,行列型に関する形式で,引数が行列,配列,指数のとき, それぞれ行列,配列,指数を返すことを意味する。 そして,3番目の形式
y = abs(s) Matrix y; String s;は少し特殊で,引数が文字列のとき行列を返すことを意味する。
関数eig()の形式を次に示す。
{D,X} = eig(A) {D,X} = eig(A,B) CoMatrix D,X; CoMatrix D,X; Matrix A; Matrix A,B;関数eig()には,形式が2種類あり, 一方は1個の行列を受け取り,もう一方は2個の行列を受け取る。 どちらの形式も2個の複素行列を返す。 関数の結果を
L = eig(A);のようにリストとして保存したり,
D = {eig(A)}(1,1,Matrix);のように多段リストを利用し,直接参照することもできる。