mxCreateUninitNumericArray (C)

初期化されない N 次元数値配列

C 構文

#include "matrix.h"
mxArray *mxCreateUninitNumericArray(size_t ndim, size_t *dims, 
  mxClassID classid, mxComplexity ComplexFlag);

引数

ndim: 次元数。2 より小さい値を ndim に指定した場合、mxCreateUninitNumericArray は次元数を自動的に 2 に設定します。
dims: 次元配列。次元配列の各要素には、その次元の配列のサイズが含まれています。たとえば、dims[0] を 5 に設定し、dims[1] を 7 に設定すると、5 行 7 列の mxArray が確立されます。通常、配列 dims には ndim 個の要素が含まれます。
classid: メモリで数値データを表す方法を決定する、配列のクラスの識別子。たとえば、mxINT16_CLASS を指定すると、mxArray 内の数値データの各数値が 16 ビットの符号付き整数として表されます。
ComplexFlag: 作成する mxArray に虚数データを含める場合、ComplexFlag を mxCOMPLEX に設定します。そうでない場合は、ComplexFlag を mxREAL に設定します。

戻り値

作成された mxArray へのポインター。スタンドアロン (非 MEX ファイル) アプリケーションで失敗した場合、NULL が返されます。MEX ファイルで失敗した場合、MEX ファイルは終了し、制御は MATLAB^® プロンプトに戻ります。関数は、mxArray を作成するのに十分な空きヒープ領域がない場合、失敗します。

説明

mxCreateUninitNumericArray を呼び出して、N 次元の mxArray を作成します。ここで、すべてのデータ要素は classid で指定される数値データ型をもちます。データ要素は初期化されません。

mxCreateUninitNumericArray は、作成した mxArray を格納するための動的メモリを割り当てます。mxDestroyArray を呼び出してメモリの割り当てを解除します。

次の表は、MATLAB クラスに相当する C の classid 値を示します。

MATLAB クラス名	C の `classid` 値
`int8`	`mxINT8_CLASS`
`uint8`	`mxUINT8_CLASS`
`int16`	`mxINT16_CLASS`
`uint16`	`mxUINT16_CLASS`
`int32`	`mxINT32_CLASS`
`uint32`	`mxUINT32_CLASS`
`int64`	`mxINT64_CLASS`
`uint64`	`mxUINT64_CLASS`
`single`	`mxSINGLE_CLASS`
`double`	`mxDOUBLE_CLASS`

参考

mxDestroyArray, mxCreateUninitNumericMatrix, mxCreateNumericArray

バージョン履歴

R2015a で導入