mxGetIr (MATLAB Application Program Interface)

Get the ir array

Fortran Syntax

integer*4 function mxGetIr(pm)
integer*4 pm

Arguments

pm
Pointer to a sparse mxArray.

Returns

A pointer to the first element in the ir array, if successful. Otherwise, returns 0. Possible causes of failure include:

Specifying a full (nonsparse) mxArray.
An earlier call to mxCreateSparse failed.

Description

Use mxGetIr to obtain the starting address of the ir array. The ir array is an array of integers; the length of the ir array is typically nzmax values. For example, if nzmax equals 100, then the ir array should contain 100 integers.

Each value in an ir array indicates a row (offset by 1) at which a nonzero element can be found. (The jc array is an index that indirectly specifies a column where nonzero elements can be found.)

For details on the ir and jc arrays, see mxSetIr and mxSetJc.