mxGetPi (外部インタフェース/API リファレンス)

mxArrayの虚数データ要素の取得

C 言語表示

#include "matrix.h"
double *mxGetPi(const mxArray *array_ptr);

引数
array_ptr
mxArrayのポインタ。

戻り値

成功した場合は、指定したmxArrayの虚数データ要素。虚数データがないか、エラーが生じた場合は、NULLを出力します。

詳細

piフィールドは、mxArrayの虚数データを含む配列を指し示します。mxGetPiを呼び出すことにより、piフィールドの中身を取得します。つまり、その虚数データの先頭アドレスを取得します。

mxArrayが純粋に実数であるかどうかを決定する最良の方法は、mxIsComplexを呼び出すことです。

MATLAB関数のすべての入力行列の虚数成分は、入力行列のいずれかが複素数ならば割り当てられます。

例題

examplesディレクトリのrefbookサブディレクトリのconvec.c, findnz.c, fulltosparse.cを参照してください。

さらに、examplesディレクトリのmexサブディレクトリのexplore.cとmexcallmatlab.cと、examplesディレクトリのmxサブディレクトリのmxcalcsinglesubscript.c, mxgetinf.c, mxisfinite.c, mxsetnzmax.cを参照してください。

参考

mxGetNzmax mxGetPr