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

2次元の要素の入っていないスパースなmxArrayを作成

C 言語表示

#include "matrix.h"
mxArray *mxCreateSparse(int m, int n, int nzmax, 
         mxComplexity ComplexFlag);

引数
m
希望する行数。

n
希望する列数。

nzmax

pr, irおよびComplexFlagがmxCOMPLEXならば、pi配列を保持するためにmxCreateSparseが割り当てる要素数。nzmaxの値は、mxArray内に設定しようとする非ゼロ要素の数以上の値に設定しますが、nzmax はm*n以下であるようにしてください。

ComplexFlag

この値は、mxREALまたはmxCOMPLEXに設定します。作成しているmxArrayが虚数データを含む場合、ComplexFlagをmxCOMPLEXに設定します。そうでない場合は、ComplexFlagをmxREALに設定します。

戻り値

成功した場合は、作成したスパースなmxArrayのポインタ。失敗した場合は、NULLを出力します。最も考えられる失敗の理由は、フリーなヒープ領域が不十分であることです。このときは、nzmax, m, nを減らしてみてください。

詳細

mxCreateSparseを呼び出すことによって、要素の入っていないスパースなmxArray.を作成します。出力されるスパースなmxArrayには、スパース性の情報は含まれず、MATLABの関数sparseの引数として渡すことはできません。出力されるスパースなmxArrayを有効にするためには、pr, ir, jc, および(存在すれば)pi配列を初期化しなければなりません。

mxCreateSparseは、以下に対して領域を割り当てます。

長さnzmaxのpr配列

長さnzmaxのpi配列(ComplexFlagがmxCOMPLEXである場合のみ)

長さnzmaxのir配列

長さn+1のjc配列

スパースなmxArrayの使用を終了するときは、mxDestroyArrayを呼び出して、すべてのヒープ領域を開放してください。

例題

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

参考

mxDestroyArray, mxSetNzmax, mxSetPr, mxSetPi, mxSetIr, mxSetJc, mxComplexity

mxCreateScalarDouble mxCreateString