| 外部インタフェース/API リファレンス | |
C 言語表示
#include "matrix.h" int mxGetNzmax(const mxArray *array_ptr);
引数
array_ptr
スパースなmxArrayのポインタ。
戻り値
成功した場合は、指定したスパースなmxArray内の非ゼロ要素を保持するために割り当てられた要素数。エラーの場合は、不定の値を出力します。最も一般的な失敗の原因は、array_ptrがフル(非スパース)mxArrayを指していることです。
詳細
mxGetNzmaxを用いて、nzmaxフィールドの値を取得します。nzmaxフィールドは、ir, pr, そして存在すればpi配列内の要素数を示す整数値をもちます。nzmaxの値は、常にスパースなmxArray内の非ゼロ要素数以上になります。さらに、nzmaxの値は、常に列数を行数倍した数以下になります。
ユーザがスパースなmxArray内の非ゼロ要素数を調整すると、MATLABはnzmaxフィールドの値を調整することがあります。MATLABは、メモリを浪費する再割り当ての数を減らし、ヒープ領域の利用を最適化するために、nzmaxを調整します。
例題
examplesディレクトリのmxサブディレクトリのmxgetnzmax.cとmxsetnzmax.cを参照してください。
参考
| | mxGetNumberOfFields | mxGetPi | |