C 行列 API

C 行列 API を使用して MATLAB データを表すために mxArray 型を使用する C プログラムを作成する

R2017b 以前の MATLAB^® と連携して動作する C プログラムを記述するには、C 行列 API の関数を使用します。これらの関数は、mxArray データ構造体と連携して動作し、C MEX 関数または C エンジンアプリケーションのビルドに使用されます。

メモ

可能な限り C アプリケーションよりも C++ を選択します。

C 行列 API には 2 つのバージョンがあります。

"インターリーブされた複素数 API" には MATLAB R2018a 時点での C 行列 API の機能が含まれています。詳細については、MATLAB の MEX 関数におけるインターリーブされた複素数 API のサポートを参照してください。
"実数/虚数分離型の複素数 API" には、MATLAB R2017b 時点での C 行列 API の機能が含まれています。

これらのライブラリ関数の使用例は、以下を参照してください。

MEX 関数のソースコード例の表
MAT ファイルのソースコードファイル一覧表
例については、個々の関数を参照してください (たとえば、mxIsChar など)。

注意

C 行列 API には、最新の C++ 機能をサポートするC++ 用の MATLAB データ APIとの互換性はありません。MATLAB (MEX ファイル) から呼び出せる C++ 関数の記述またはC++ からの MATLAB の呼び出しで説明するように、C 行列 API 関数は MATLAB API 内の関数と共に使用できません。

C データ型

`mxArray`	MATLAB 配列の C 型
`mwSize`	mxArray のサイズ値に用いる C の型
`mwIndex`	mxArray のインデックス値を表す C の型
`mwSignedIndex`	mxArray のサイズ値に用いる C の符号付き整数型
`mxChar`	string 配列の型
`mxLogical`	logical 配列の型
`mxComplexity`	配列に虚数部があるかどうかを指定するフラグ

mxArray の属性

`mxIsNumeric`	mxArray が数値であるかどうかを判別
`mxIsComplex`	データが複素数であるかどうかを判別
`mxGetNumberOfDimensions`	mxArray の次元数
`mxGetElementSize`	各データ要素を格納するのに必要なバイト数
`mxGetDimensions`	次元配列へのポインター
`mxSetDimensions`	次元数と各次元のサイズを変更
`mxGetNumberOfElements`	数値 mxArray の要素数
`mxCalcSingleSubscript`	最初の要素から目的の要素へのオフセット
`mxGetM`	mxArray の行数
`mxSetM`	mxArray の行数を設定
`mxGetN`	mxArray の列数
`mxSetN`	mxArray の列数を設定
`mxIsEmpty`	mxArray が空かどうかを判別
`mxIsFromGlobalWS`	mxArray が MATLAB グローバルワークスペースからコピーされたかどうかを判別

データ型の作成、クエリ、およびアクセス

すべて展開する

数値型

`mxCreateDoubleMatrix`	2 次元倍精度浮動小数点配列
`mxCreateDoubleScalar`	指定した値に初期化されるスカラーの倍精度配列
`mxCreateNumericMatrix`	2 次元数値行列
`mxCreateNumericArray`	N 次元数値配列
`mxCreateUninitNumericMatrix`	初期化されない 2 次元数値行列
`mxCreateUninitNumericArray`	初期化されない N 次元数値配列

複素数以外の浮動小数点

`mxIsScalar`	配列がスカラー配列かどうかを判定
`mxGetScalar`	配列内の最初のデータ要素の実数部
`mxIsDouble`	mxArray が倍精度浮動小数点数としてデータを表しているかどうかを判別
`mxGetDoubles`	`mxDOUBLE_CLASS` 配列内の実数データ要素
`mxSetDoubles`	`mxDOUBLE_CLASS` 配列内に実数データ要素を設定
`mxIsSingle`	mxArray が単精度浮動小数点数としてデータを表しているかどうかを判別
`mxGetSingles`	`mxSINGLE_CLASS` 配列内の実数データ要素
`mxSetSingles`	`mxSINGLE_CLASS` 配列内に実数データ要素を設定
`mxGetPr`	(非推奨) `mxDOUBLE_CLASS` 配列内の実数データ要素
`mxSetPr`	(非推奨) `mxDOUBLE_CLASS` 配列内に実数データ要素を設定

複素数以外の整数

`mxIsInt8`	mxArray が 8 ビット符号付き整数としてデータを表しているかどうかを判別
`mxGetInt8s`	`mxINT8_CLASS` 配列内の実数データ要素
`mxSetInt8s`	`mxINT8_CLASS` 配列内に実数データ要素を設定
`mxIsUint8`	mxArray が 8 ビット符号なし整数としてデータを表しているかどうかを判別
`mxGetUint8s`	`mxUINT8_CLASS` 配列内の実数データ要素
`mxSetUint8s`	`mxUINT8_CLASS` 配列内に実数データ要素を設定
`mxIsInt16`	mxArray が 16 ビット符号付き整数としてデータを表しているかどうかを判別
`mxGetInt16s`	`mxINT16_CLASS` 配列内の実数データ要素
`mxSetInt16s`	`mxINT16_CLASS` 配列内に実数データ要素を設定
`mxIsUint16`	mxArray が 16 ビット符号なし整数としてデータを表しているかどうかを判別
`mxGetUint16s`	`mxUINT16_CLASS` 配列内の実数データ要素
`mxSetUint16s`	`mxUINT16_CLASS` 配列内に実数データ要素を設定
`mxIsInt32`	mxArray が 32 ビット符号付き整数としてデータを表しているかどうかを判別
`mxGetInt32s`	`mxINT32_CLASS` 配列内の実数データ要素
`mxSetInt32s`	`mxINT32_CLASS` 配列内に実数データ要素を設定
`mxIsUint32`	mxArray が 32 ビット符号なし整数としてデータを表しているかどうかを判別
`mxGetUint32s`	`mxUINT32_CLASS` 配列内の実数データ要素
`mxSetUint32s`	`mxUINT32_CLASS` 配列内に実数データ要素を設定
`mxIsInt64`	mxArray が 64 ビット符号付き整数としてデータを表しているかどうかを判別
`mxGetInt64s`	`mxINT64_CLASS` 配列内の実数データ要素
`mxSetInt64s`	`mxINT64_CLASS` 配列内にデータ要素を設定
`mxIsUint64`	mxArray が 64 ビット符号なし整数としてデータを表しているかどうかを判別
`mxGetUint64s`	`mxUINT64_CLASS` 配列内の実数データ要素
`mxSetUint64s`	`mxUINT64_CLASS` 配列内に実数データ要素を設定

複素数の浮動小数点

`mxGetComplexDoubles`	`mxDOUBLE_CLASS` 配列内の複素数データ要素
`mxSetComplexDoubles`	`mxDOUBLE_CLASS` 配列内に複素数データ要素を設定
`mxGetComplexSingles`	`mxSINGLE_CLASS` 配列内の複素数データ要素
`mxSetComplexSingles`	`mxSINGLE_CLASS` 配列内に複素数データ要素を設定
`mxGetImagData`	数値 `mxArray` 内の虚数データ要素
`mxSetImagData`	数値 `mxArray` 内に虚数データ要素を設定
`mxGetPi`	(非推奨) `mxDOUBLE_CLASS` 配列内の虚数データ要素
`mxSetPi`	(非推奨) `mxDOUBLE_CLASS` 配列内に虚数データ要素を設定

複素数の整数

`mxGetComplexInt8s`	`mxINT8_CLASS` 配列内の複素数データ要素
`mxSetComplexInt8s`	`mxINT8_CLASS` 配列内に複素数データ要素を設定
`mxGetComplexUint8s`	`mxUINT8_CLASS` 配列内の複素数データ要素
`mxSetComplexUint8s`	`mxUINT8_CLASS` 配列内に複素数データ要素を設定
`mxGetComplexInt16s`	`mxINT16_CLASS` 配列内の複素数データ要素
`mxSetComplexInt16s`	`mxINT16_CLASS` 配列内に複素数データ要素を設定
`mxGetComplexUint16s`	`mxUINT16_CLASS` 配列内の複素数データ要素
`mxSetComplexUint16s`	`mxUINT16_CLASS` 配列内に複素数データ要素を設定
`mxGetComplexInt32s`	`mxINT32_CLASS` 配列内の複素数データ要素
`mxSetComplexInt32s`	`mxINT32_CLASS` 配列内に複素数データ要素を設定
`mxGetComplexUint32s`	`mxUINT32_CLASS` 配列内の複素数データ要素
`mxSetComplexUint32s`	`mxUINT32_CLASS` 配列内に複素数データ要素を設定
`mxGetComplexInt64s`	`mxINT64_CLASS` 配列内の複素数データ要素
`mxSetComplexInt64s`	`mxINT64_CLASS` 配列内に複素数データ要素を設定
`mxGetComplexUint64s`	`mxUINT64_CLASS` 配列内の複素数データ要素
`mxSetComplexUint64s`	`mxUINT64_CLASS` 配列内に複素数データ要素を設定
`mxGetPi`	(非推奨) `mxDOUBLE_CLASS` 配列内の虚数データ要素
`mxSetPi`	(非推奨) `mxDOUBLE_CLASS` 配列内に虚数データ要素を設定

Sparse

`mxCreateSparse`	2 次元スパース配列
`mxCreateSparseLogicalMatrix`	2 次元スパース logical 配列
`mxIsSparse`	入力がスパースの mxArray であるかどうかを判別
`mxGetNzmax`	配列 IR、PR、および PI 内の要素数
`mxSetNzmax`	非ゼロ要素のストレージスペースの設定
`mxGetIr`	スパース行列の配列 IR
`mxSetIr`	スパース配列の配列 IR
`mxGetJc`	スパース行列の配列 JC
`mxSetJc`	スパース配列の配列 JC

非数値型

`mxGetData`	非数値 `mxArray` 内のデータ要素
`mxSetData`	非数値 `mxArray` 内のデータ要素へのポインターを設定

文字

`mxCreateString`	指定された文字列に初期化された 1 次元配列
`mxCreateCharMatrixFromStrings`	指定値に初期化された 2 次元の `mxChar` 配列
`mxCreateCharArray`	N 次元の `mxChar` 配列
`mxIsChar`	入力が配列 `mxChar` かどうかを判定
`mxGetChars`	文字配列データへのポインター

logical

`mxIsLogical`	mxArray が `mxLogical` 型であるかどうかを判別
`mxIsLogicalScalar`	スカラー配列が mxLogical 型であるかどうかを判別
`mxIsLogicalScalarTrue`	mxLogical 型のスカラー配列が true であるかどうかを判別
`mxClassID`	配列のクラスを識別する列挙値
`mxCreateLogicalArray`	N 次元 logical 配列
`mxCreateLogicalMatrix`	2 次元 logical 配列
`mxCreateLogicalScalar`	スカラーの logical 配列
`mxGetLogicals`	logical 配列データへのポインター

オブジェクト

`mxIsClass`	mxArray が指定のクラスのオブジェクトであるかどうかを判別
`mxGetClassID`	mxArray のクラス
`mxGetClassName`	文字列としての mxArray のクラス
`mxSetClassName`	構造体配列の MATLAB オブジェクト配列への変換
`mxGetProperty`	MATLAB オブジェクトのパブリックプロパティの値
`mxSetProperty`	MATLAB オブジェクトのパブリックプロパティの値を設定

構造体

`mxCreateStructMatrix`	2 次元構造体配列
`mxCreateStructArray`	N 次元構造体配列
`mxIsStruct`	mxArray が構造体であるかどうかを判別
`mxGetField`	構造体配列からフィールド値へのポインター (インデックスおよびフィールド名を指定)
`mxSetField`	インデックスおよびフィールド名を指定して、構造体配列にフィールド値を設定
`mxGetNumberOfFields`	構造体配列のフィールド数。
`mxGetFieldNameByNumber`	構造体配列からフィールド名へのポインター (フィールド番号を指定)
`mxGetFieldNumber`	構造体配列内のフィールド番号 (フィールド名を指定)
`mxGetFieldByNumber`	構造体配列からフィールド値へのポインター (インデックスおよびフィールド番号を指定)
`mxSetFieldByNumber`	インデックスおよびフィールド番号を指定して、構造体配列にフィールド値を設定
`mxAddField`	構造体配列へのフィールド追加
`mxRemoveField`	構造体配列からのフィールドの削除

cell

`mxCreateCellMatrix`	2 次元 cell 配列
`mxCreateCellArray`	N 次元 cell 配列
`mxIsCell`	mxArray が cell 配列かどうかを判別
`mxGetCell`	cell 配列の要素へのポインター
`mxSetCell`	cell 配列の内容を設定

mxArray の削除と複製

`mxDestroyArray`	関数 MXCREATE* によって割り当てられた動的メモリを解放
`mxDuplicateArray`	配列のディープコピーを作成

mxArray の変換