GET_MATRIX_INFO

Use

The function can be called by any user subroutine.

Format

Fortran Calling Syntax

CALL GET_MATRIX_INFO(id, type, nrows, ncols, size, ierr)

C/C++ Calling Syntax

c_get_matrix_info(id, type, nrows, ncols, size, ierr)

Python Calling Syntax

[type, nrows, ncols, size, ierr] = py_get_matrix_info(id)

MATLAB Calling Syntax

[type, nrows, ncols, size, ierr] = m_get_matrix_info(id)

Attributes

id

[integer]

The ID of the Reference_Matrix element.

Output

type

[integer]

The type of Reference_Matrix as follows:

1

Sparse.

2

Full, row-order.

3

Full, column-order.

nrows

[integer]

The number of rows.

ncols

[integer]

The number of columns.

size

[integer]

The total number of entries. For sparse matrix, it is the number of non-zero entries. For full matrix, it is nrows*ncols.

ierr

[integer]

An integer that specifies the status of the call to the GET_MATRIX_INFO as follows:

0

Normal return.

1

ID not found, call ignored.