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

mxIsComplex

mxArrayが複素数であるかどうかを判別

Fortran 言語表示

integer*4 function mxIsComplex(pm)
integer*4 pm

引数
pm
   mxArrayのポインタ。

戻り値

複素数の場合は1、そうでない場合は0。

詳細

mxIsComplexを用いて、mxArrayに対して虚数成分が割り当てられているかどうかを決定します。虚数のポインタpiは、mxArrayが純粋に実数で、虚数データをもたない場合は0です。mxArrayが複素数である場合は、piは数値配列のポインタになります。

MEX-ファイルが呼び出されるとき、MATLABは、すべての入力(右辺)配列を自動的に調べます。入力配列のいずれかが複素数である場合、MATLABはそれ以外のすべての入力配列に対する虚数データを保持するためのメモリを自動的に割り当てます。たとえば、Jestという名前のMEX-ファイルに、3つの入力変数(apricot, banana, carambola) を渡すとします。

apricot = 7;
banana = sqrt(-5:5);
carambola = magic(2);
Jest(apricot, banana, carambola);

bananaは複素数です。そのため、配列apricotが純粋に実数であっても、MATLABはapricotの虚数値を保持するための領域(1要素)を自動的に割り当てます。MATLABは、carambolaの存在しない虚数値を保持するための領域(4要素)も自動的に割り当てます。

言い換えると、MATLABはすべての入力配列を強制的に実数とするか、あるいは複素数とします。

参考

mxIsNumeric

mxGetString

mxIsDouble