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

mxGetN

2次元のmxArrayの列の総数、またはm行n列の配列に対する2からNの次元の要素の総数を取得

C 言語表示

#include "matrix.h"
int mxGetN(const mxArray *array_ptr);

引数
array_ptr
   mxArrayのポインタ。

戻り値

mxArray内の列数。

詳細

mxGetNを呼び出すことによって、指定したmxArray内の列数を決定します。

array_ptrがN次元のmxArrayである場合、mxGetNは2からNの次元の積です。たとえば、array_ptrが13×5×4×6の次元をもつ4次元のmxArrayを指す場合、mxGetNは値120(5x4x6)を出力します。指定したmxArrayが2次元よりも大きく、各々の次元の要素数を正確に知る必要がある場合は、mxGetDimensionsを呼び出してください。

array_ptrがスパースなmxArrayを指す場合、mxGetNは列数を出力しますが、0でない列の数は出力しません。

例題

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

さらに、以下を参照してください。

• examplesディレクトリのrefbookサブディレクトリのfulltosparse.c, revord.c, timestwo.c, xtimesy.c
• examplesディレクトリのmexサブディレクトリのexplore.c, mexget.c, mexlock.c, mexsettrapflag.c, yprime.c
• examplesディレクトリのmxサブディレクトリのmxmalloc.c, mxsetdimensions.c, mxgetnzmax.c, mxsetnzmax.c

参考

mxGetM, mxGetNumberOfDimensions, mxSetM, mxSetN

mxGetM

mxGetName