Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

mxGetPi (C)

(非推奨) mxDOUBLE_CLASS 配列内の虚数データ要素

mxGetPi は、インターリーブされた複素数 API では使用できません。代わりに mxGetComplexDoubles を使用してください。詳細については、互換性についての考慮事項を参照してください。

C 構文

#include "matrix.h"
mxDouble *mxGetPi(const mxArray *pm);

説明

実数/虚数分離型複素数 API を使用して MEX ファイルをビルドする場合は、mxGetPi を呼び出して、pi フィールドの内容を取得します。pimxArray の虚数データを含む配列です。mxGetPi は配列の型が mxDOUBLE_CLASS の場合にのみ使用します。その他の数値型の mxArray の場合は、mxGetImagData を使用します。

mxArray の型を確認するには、mxIsDouble を呼び出します。mxIsComplex を呼び出して、データが複素数かどうかを判別します。

関数への入力行列のいずれかが複素数である場合、MATLAB® はすべての入力行列の虚数部を割り当てます。

入力引数

すべて展開する

mxDOUBLE_CLASS 型の MATLAB 配列へのポインター。mxArray * として指定します。

複素数のサポート: あり

出力引数

すべて展開する

mxArray 内にあるデータ配列の虚数部の最初の mxDouble 要素へのポインター。mxDouble * として指定します。虚数データが存在しない場合やエラーが発生した場合、関数は NULL を返します。

複素数のサポート: あり

互換性についての考慮事項

すべて展開する

R2018a 以降は非推奨

R2018a 以降はエラー

R2006a より前に導入