mxGetNzmax, mxSetNzmax

Purpose

Get and set the maximum number of sparse nonzero entries.

C Synopsis

int mxGetNzmax(pm)
  Matrix *pm;
void mxSetNzmax(pm,nzmax)
  Matrix *pm;
  int nzmax;

Fortran Synopsis

integer*4 function mxGetNzmax(pm)
subroutine mxSetNzmax(pm,nzmax)
integer*4 pm, nzmax

Arguments

nzmax: maximum number of nonzero entries
pm: pointer to the Matrix structure

Description

If a Matrix is sparse, nzmax is the number of nonzero entries in the sparse Matrix and therefore the length of the ir array.

If a Matrix is full, mxGetNzmax returns an indeterminate value.

mxSetNzmax does not affect the length of the ir array - it is up to you to make sure it is consistent.

mxGetNzmax and mxSetNzmax allow you to get and set the value of nzmax. See the "Matrix Data Structure" section in Chapter 1 for more information on sparse Matrices and nzmax.