mxGetData (Fortran)

非数値 mxArray 内のデータ要素

mxGetData は数値配列用には推奨されません。代わりに、型付きのデータ アクセス関数を使用してください。詳細については、互換性についての考慮事項を参照してください。

Fortran 構文

#include "fintrf.h"
mwPointer mxGetData(pm)
mwPointer pm

説明

mxGetData は、非数値配列のみのデータ要素の取得に使用します。

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

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

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

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

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

入力引数

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

mwPointer

非数値 MATLAB 配列へのポインター。mwPointer として指定します。

出力引数

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

mwPointer | 0

mxArray 内のデータ配列へのポインター。mwPointer として指定します。void ポインターは型のない値を指すので、戻り値は pm によって指定されている型に一致するポインター型にキャストします。

返されたポインターからの値をコピーするには、関数 mxCopyPtrTo* のいずれかを使用します。以下に例を示します。

C      Get the data in mxArray, pm
       mxCopyPtrToReal8(mxGetData(pm),data,
     +                  mxGetNumberOfElements(pm))

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

バージョン履歴

R2006a より前に導入

R2018b: 複素数の mxArray の場合、mxGetData の戻り値のキャストはビルド オプションによって異なる

関数 mxGetData は mwPointer を返します。mxArray 入力引数で指定されている型に一致するポインターの型を、コードでは宣言しなければなりません。複素数入力の場合、正しい型は、MEX ファイルの作成に使用するビルド オプションによって異なります。

既定のリリース特定オプション (-R2017b) を使用して MEX ファイルをビルドする場合、関数は、実数のみの値の最初の要素を指すポインターを返します。

-R2018a オプションを使用して MEX ファイルをビルドする場合は、次のようになります。

• 入力引数 pm が実数の MATLAB 配列を指している場合、関数はデータの最初の要素へのポインターを返す。

• pm が複素数配列である場合、関数は、実数のみの値を指すポインターではなく、インターリーブされた実数値と虚数値の最初の要素へのポインターを返す。

参考

トピック

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