mxGetImagData (C)

数値 mxArray 内の虚数データ要素

mxGetImagData は、インターリーブされた複素数 API では使用できません。代わりに、型付きのデータ アクセス関数を使用してください。詳細については、バージョン履歴を参照してください。

C 構文

#include "matrix.h"
void *mxGetImagData(const mxArray *pm);

説明

関数 mxGetImagData は mxGetPi と類似していますが、C では void * が返される点が異なります。詳細については、関数 mxGetData の説明を参照してください。

入力引数

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

mxArray *

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

出力引数

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

void * | NULL

mxArray 内の複素数データ配列へのポインター。void * として指定します。void ポインターは型のない値を指すので、戻り値は pm によって指定されている型に一致するポインター型にキャストします。MATLAB の型を対応する C の型にマッピングする場合の詳細については、mxClassID を参照してください。

pm が NULL の場合、関数は NULL を返します。

複素数のサポート: あり

バージョン履歴

R2006a より前に導入

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

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

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

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

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

• 例 explore.c

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

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

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

mex -R2017b myMexFile.c

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

参考

mxClassID

トピック

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