mxGetClassID (外部インタフェース/API リファレンス)

mxArrayのクラスを(数値の定数として)取得

C 言語表示

#include "matrix.h"
mxClassID mxGetClassID(const mxArray *array_ptr);

引数
array_ptr
mxArrayのポインタ。

戻り値

array_ptr が指すmxArrayのクラス(カテゴリ)は、つぎのものです。

mxCELL_CLASS
セルのmxArrayを示します。

mxSTRUCT_CLASS
構造体のmxArrayを示します。

mxOBJECT_CLASS
ユーザ定義(非標準)のmxArrayを示します。

mxCHAR_CLASS
文字列のmxArrayを示します。つまり、データがmxCHARとして表されるmxArrayです。

mxSPARSE_CLASS
スパースmxArrayを示します。つまり、非ゼロ要素のみを格納するmxArrayです。

mxDOUBLE_CLASS
データが倍精度浮動小数値として格納されている数値mxArrayを示します。

mxSINGLE_CLASS
データが単精度浮動小数値として格納されている数値mxArrayを示します。

mxINT8_CLASS
データが符号付き8ビット整数として格納されている数値mxArrayを示します。

mxUINT8_CLASS
データが符号なし8ビット整数として格納されている数値mxArrayを示します。

mxINT16_CLASS
データが符号付き16ビット整数として格納されている数値mxArrayを示します。

mxUINT16_CLASS
データが符号なし16ビット整数として格納されている数値mxArrayを示します。

mxINT32_CLASS
データが符号付き32ビット整数として格納されている数値mxArrayを示します。

mxUINT32_CLASS
データが符号なし32ビット整数として格納されている数値mxArrayを示します。

mxINT64_CLASS
将来の利用のために予約されています。

mxUINT64_CLASS
将来の利用のために予約されています。

mxUNKNOWN_CLASS = -1
クラスは決定できません。ユーザは、このカテゴリーをmxArrayに対して指定できません。しかし、mxGetClassIDは、クラスを識別できない場合はこの値を出力します。

詳細

mxGetClassIdを用いると、mxArrayのクラスを決定できます。mxArrayのクラスは、mxArrayがもっているデータの種類を示します。たとえば、ポインタarray_ptrがスパースなmxArrayを指す場合は、mxGetClassIDはmxSPARSE_CLASS. を出力します。

mxGetClassIDはクラスを数値として出力し、mxGetClassNameはクラスを文字列として出力すること以外は、両者は同じです。

例題

examplesディレクトリのrefbookサブディレクトリのphonebook.cと、examplesディレクトリのmexサブディレクトリのexplore.cを参照してください。

参考

mxGetClassName

mxGetCell mxGetClassName