Main Content

mxCreateLogicalArray (C)

N 次元 logical 配列

C 構文

#include "matrix.h"
mxArray *mxCreateLogicalArray(mwSize ndim, const mwSize *dims);

引数

ndim

次元数。2 より小さい値を ndim に指定した場合、mxCreateLogicalArray は次元数を自動的に 2 に設定します。

dims

次元配列。次元配列の各要素には、その次元の配列のサイズが含まれています。たとえば、dims[0] を 5 に設定し、dims[1] を 7 に設定すると、5 行 7 列の mxArray が確立されます。配列 dims には ndim 要素があります。

戻り値

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

説明

mxCreateLogicalArray を呼び出して、mxLogical 要素からなる N 次元の mxArray を作成します。mxArray を作成した後、mxCreateLogicalArray はそのすべての要素を logical 0 に初期化します。mxCreateLogicalArray は mxCreateLogicalMatrix とは異なり、後者は 2 次元配列しか作成できません。

mxCreateLogicalArray は、作成した mxArray を格納するための動的メモリを割り当てます。作成した mxArray を使用し終わったら、mxDestroyArray を呼び出してそのメモリの割り当てを解除します。

MATLAB は、dims 引数に指定されている、後に続く大きさが 1 の次元を自動的に削除します。たとえば、ndim が 5 で dims が [4 1 7 1 1] である場合、結果の配列には 4 x 1 x 7 の次元が含まれます。

バージョン履歴

R2006a より前に導入

参考

| |