mxGetPi (C)

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

mxGetPi は、インターリーブされた複素数 API では使用できません。代わりに mxGetComplexDoubles を使用してください。詳細については、バージョン履歴を参照してください。

C 構文

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

説明

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

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

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

入力引数

pm — MATLAB 配列へのポインター

mxArray *

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

複素数のサポート: あり

出力引数

pi — データ配列へのポインター

mxDouble * | NULL

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

複素数のサポート: あり

バージョン履歴

R2006a より前に導入

R2018a: 実数/虚数分離型複素数 API は使用しない

インターリーブされた複素数 API では、関数 mxGetPr および mxGetPi の代わりに関数 mxGetComplexDoubles を使用します。この関数は、入力配列が複素数であり mxDOUBLE_CLASS 型であることを検証します。

MathWorks では、インターリーブされた複素数 API で型付きのデータ アクセス関数を使用するように、MEX ファイルを作成し、既存の MEX ファイルを更新することを推奨します。詳細については、以下を参照してください。

• C MEX ファイルでの型付きデータ アクセス

• MATLAB の MEX 関数におけるインターリーブされた複素数 API のサポート

• インターリーブされた複素数 API を使用するように MEX ファイルをアップグレード

• 例 convec.c

MEX ファイルをビルドするには、-R2018a オプションを指定して mex を呼び出します。

R2018a: インターリーブされた複素数 API で mxGetPi をビルドする際のエラー

関数 mxGetPi は実数/虚数分離型複素数 API でのみ使用できます。この関数を使用して myMexFile.c をビルドするには、以下を入力します。

mex -R2017b myMexFile.c

この関数を使用してビルドされた既存の MEX ファイルは引き続き機能します。

参考

mxGetComplexDoubles

トピック

• convec.c
• C MEX ファイルでの型付きデータ アクセス
• MATLAB の MEX 関数におけるインターリーブされた複素数 API のサポート