| 外部インタフェース/API リファレンス | |
Fortran 言語表示
integer*4 function mxGetPi(pm) integer*4 pm
戻り値
成功した場合は、指定したmxArrayの虚数データ要素。虚数データがないか、エラーが生じた場合は、0を出力します。
詳細
piフィールドは、mxArrayの虚数データを含む配列を指し示します。mxGetPiを呼び出すことにより、piフィールドの中身を取得します。つまり、その虚数データの開始アドレスを取得します。
mxArrayが純粋に実数であるかどうかを決定する最良の方法は、mxIsComplexを呼び出すことです。
MATLAB関数のすべての入力mxArrayの虚数部分は、入力mxArrayのいずれかが複素数ならば割り当てられます。
mxGetPrまたはmxGetPiを用いる場合、mxFreeMatrixはmxFreeを使ってprとpiを開放するので、prとpiはmxCallocによって割り当てられたメモリに設定されます。
参考
| | mxGetNzmax | mxGetPr | |