mxGetPr (C)

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

このページをすべて展開する

mxGetPr は推奨されません。代わりに mxGetDoubles または mxGetComplexDoubles を使用してください。詳細については、バージョン履歴を参照してください。

C 構文

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

説明

mxGetPr は実数配列の型が mxDOUBLE_CLASS の場合にのみ使用します。その他の数値型の mxArray の場合は、C MEX ファイルでの型付きデータ アクセス関数を使用します。複素数配列の場合は、出力引数 dt の説明を参照してください。

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

入力引数

すべて展開する

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

出力引数

すべて展開する

mxArray 内のデータ配列へのポインター。mxDouble * として指定します。出力引数内のデータは、使用する C 行列 API のバージョンによって異なります。

  • 実数/虚数分離型の複素数 API (mex -R2017b オプション) でビルドする場合、データの実数部の最初の mxDouble 要素へのポインターが返される。

  • インターリーブされた複素数 API (mex -R2018a オプション) でビルドし、pm が複素数である場合は、この関数によって MEX ファイルが終了され、制御が MATLAB プロンプトに戻ります。非 MEX ファイル アプリケーションでは、関数は NULL を返します。

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

バージョン履歴

R2006a より前に導入

すべて展開する

参考

|

トピック