S3L_free_sparse

Description

S3L_free_sparse deallocates the memory reserved for a sparse matrix and the associated array handle.

Syntax

The C and Fortran syntax for S3L_free_sparse are shown below.

C/C++ Syntax

Example 8-13

#include <s3l/s3l-c.h>
#include <s3l/s3l_errno-c.h>
int
S3L_free_sparse(A)
    S3L_array_t             *A

F77/F90 Syntax

Example 8-14

include `s3l/s3l-f.h'
include `s3l/s3l_errno-f.h'
subroutine
S3L_free_sparse(A ier)
    integer*8          *A
    integer*4          ier

Input

S3L_free_sparse accepts the following argument as input:

• A - Handle for the parallel S3L array that was allocated via a previous call to S3L_declare_sparse, S3L_read_sparse, or S3L_rand_sparse.

Output

S3L_free_sparse uses the following argument for output:

• ier (Fortran only) - When called from a Fortran program, S3L_free_sparse returns error status in ier.

Error Handling

On success, S3L_free_sparse returns S3L_SUCCESS.

On error, the following error code may be returned:

• S3L_ERR_ARG_ARRAY - A is a NULL pointer (C/C++) or 0 (F77/F90).

Examples

../examples/s3l/sparse/ex_sparse.c
../examples/s3l/sparse/ex_sparse2.c
../examples/s3l/iter/ex_iter.c
../examples/s3l/sparse-f/ex_sparse.f
../examples/s3l/iter-f/ex_iter.f

Related Functions

S3L_declare_sparse(3)
S3L_read_sparse(3)
S3L_rand_sparse(3)