| 外部インタフェース/API リファレンス | |
C 言語表示
#include "matrix.h" double mxGetScalar(const mxArray *array_ptr);
引数
array_ptr
セルのmxArrayまたは構造体のmxArray以外のmxArrayのポインタ。
戻り値
mxArrayの最初の実数(非虚数)要素の値。mxGetScalarはdoubleを出力することに注意してください。そのため、mxArrayの実数要素がdouble以外のものとして格納される場合、mxGetScalarはスカラ値をdoubleに自動的に変換します。スカラのオリジナルのデータ表現を保存するためには、戻り値が希望するデータタイプでなければなりません。
array_ptrが構造体のmxArrayまたはセルのmxArrayを指す場合、mxGetScalarは0.0を出力します。
array_ptrがスパースなmxArrayを指す場合、mxGetScalarはmxArrayの最初の非ゼロの実数要素の値を出力します。
array_ptrが空のmxArrayを指す場合、mxGetScalarは不定の値を出力します。
詳細
mxGetScalarを呼び出すことによって、mxArrayの最初の実数(非虚数)要素の値を取得します。
ほとんどの場合で、array_ptrが1つの要素のみ(スカラ)を含むmxArrayを指すとき、mxGetScalarを呼び出します。しかし、array_ptrは多くの要素を含むmxArrayを指すポインタとして使うことができます。array_ptrが複数の要素を含むmxArrayを指す場合、mxGetScalarは最初の実数要素の値を出力します。array_ptrが2次元のmxArrayを指す場合、 mxGetScalarは(1,1)要素の値を出力し、array_ptrが3次元のmxArrayを指す場合、mxGetScalarは(1,1,1)要素の値を出力、のようになります。
例題
examplesディレクトリのrefbookサブディレクトリのtimestwoalt.cとxtimesy.cを参照してください。
さらに、examplesディレクトリのmxサブディレクトリのmxsetdimensions.cと、examplesディレクトリのmexサブディレクトリのmexget.c, mexlock.cとmexsettrapflag.cを参照してください。
参考
| | mxGetPr | mxGetString | |