mxGetNzmax (C および Fortran)

配列 IR、PR、および PI 内の要素数

C 構文

#include "matrix.h"
mwSize mxGetNzmax(const mxArray *pm);

Fortran 構文

#include "fintrf.h"
mwSize mxGetNzmax(pm)
mwPointer pm

引数

pm

スパース mxArray へのポインター

戻り値

成功した場合、指定されたスパース mxArray 内の非ゼロ エントリを格納するために割り当てられている要素の数。エラーの場合は不確定な値を返します。失敗した場合に最も考えられる原因は、pm がフル (非スパース) の mxArray を指していることです。

説明

mxGetNzmax を使用して、nzmax フィールドの値を取得します。nzmax フィールドは、配列 ir、配列 pr、および配列 pi (存在する場合) 内の要素数を表す整数値を格納します。nzmax の値は必ず、スパース mxArray 内の非ゼロ要素の数以上になります。また、nzmax の値は必ず、行数と列数を掛けた値以下になります。

スパース mxArray 内の非ゼロ要素の数を調整する場合、MATLAB^® ソフトウェアでは通常は nzmax フィールドの値を調整します。MATLAB は nzmax を調整することで、時間のかかる再割り当ての数を削減し、ヒープ領域の使用を最適化します。

例

例を開くには、次のように入力します。

edit([fullfile(matlabroot,"extern","examples","mx","filename")]);

ここで filename は、次のようになります。

• mxgetnzmax.c

• mxsetnzmax.c

参考

mxSetNzmax

バージョン履歴

R2006a より前に導入