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

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

Fortran 言語表示

integer*4 function mxCreateSparse(m, n, nzmax, ComplexFlag)
integer*4 m, n, nzmax, ComplexFlag

引数
m
希望する行数。

n
希望する列数。

nzmax

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

ComplexFlag

データが虚数成分をもたない場合はREAL = 0と指定し、データが虚数成分をもつ場合はCOMPLEX = 1と指定してください。

戻り値

成功した場合は、要素の入っていないスパースなmxArray。そうでない場合は0。

詳細

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

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

長さnzmaxのpr配列。

長さnzmaxのpi配列(ComplexFlagがCOMPLEX = 1の場合のみ)。

長さnzmaxのir配列。

長さn+1のjc配列。

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

参考

mxFreeMatrix, mxSetNzmax, mxSetPr, mxSetIr, mxSetJc

mxCreateFull mxCreateString