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

mxArrayが指定したクラスのメンバであれば真

C 言語表示

#include "matrix.h"
bool mxIsClass(const mxArray *array_ptr, const char *name);

引数
array_ptr
配列のポインタ。

name

ユーザがテストする配列のカテゴリ。nameを(数値定数ではなく)文字列として指定します。以下の前もって定義された定数のいずれかを指定することができます。

表で、<class_name>は、特定のMATLABオブジェクト名またはカスタムオブジェクト名です。

あるいは、ユーザが定義したクラス名を指定することができます。

たとえば、

mxIsClass("double");

は、以下の呼び出しと等価です。

mxIsDouble(array_ptr);

これは、以下の呼び出しと等価です。

strcmp(mxGetClassName(array_ptr), "double");

mxIsDoubleの形式の利用が最も効率的です。

戻り値

array_ptrがカテゴリnameをもつ配列を指す場合は真。そうでない場合は偽を出力します。

詳細

各々のmxArrayは、あるタイプとしてタグが付けられています。指定したmxArrayがそのタイプかどうかは、mxIsClassを呼び出して決定します。

例題

examplesディレクトリのmxサブディレクトリのmxisclass.cを参照してください。

参考

mxIsChar mxIsComplex