Create_CompCol_Matrix(3P) Sun Performance Library Create_CompCol_Matrix(3P)NAME
Create_CompCol_Matrix: cCreate_CompCol_Matrix, dCreate_CompCol_Matrix,
sCreate_CompCol_Matrix, zCreate_CompCol_Matrix - A utility C function
in the serial SuperLU solver that creates a SuperMatrix in compressed
sparse column format (also known as the Harwell-Boeing format).
SYNOPSIS
#include <sunperf.h>
void sCreate_CompCol_Matrix(SuperMatrix *A, int m, int n, int nnz,
float *nzval, int *rowind, int *colptr, Stype_t stype,
Dtype_t dtype, Mtype_t mtype);
void dCreate_CompCol_Matrix(SuperMatrix *A, int m, int n, int nnz, dou‐
ble *nzval, int *rowind, int *colptr, Stype_t stype, Dtype_t
dtype, Mtype_t mtype);
void cCreate_CompCol_Matrix(SuperMatrix *A, int m, int n, int nnz, com‐
plex *nzval, int *rowind, int *colptr, Stype_t stype, Dtype_t
dtype, Mtype_t mtype);
void zCreate_CompCol_Matrix(SuperMatrix *A, int m, int n, int nnz, dou‐
blecomplex *nzval, int *rowind, int *colptr, Stype_t stype,
Dtype_t dtype, Mtype_t mtype);
void sCreate_CompCol_Matrix_64(SuperMatrix_64 *A, long m, long n, long
nnz, float *nzval, long *rowind, long *colptr, Stype_t stype,
Dtype_t dtype, Mtype_t mtype);
void dCreate_CompCol_Matrix_64(SuperMatrix_64 *A, long m, long n, long
nnz, double *nzval, long *rowind, long *colptr, Stype_t
stype, Dtype_t dtype, Mtype_t mtype);
void cCreate_CompCol_Matrix_64(SuperMatrix_64 *A, long m, long n, long
nnz, complex *nzval, long *rowind, long *colptr, Stype_t
stype, Dtype_t dtype, Mtype_t mtype);
void zCreate_CompCol_Matrix_64(SuperMatrix_64 *A, long m, long n, long
nnz, doublecomplex *nzval, long *rowind, long *colptr,
Stype_t stype, Dtype_t dtype, Mtype_t mtype);
PURPOSECreate_CompCol_Matrix() creates a SuperMatrix in compressed column for‐
mat.
ARGUMENTS
SuperMatrix *A (output)
On exit, A holds an allocated matrix as well as all the
describing elements of the structure object.
int m (input)
m specifies the number of rows of the matrix to be created.
int n (input)
n specifies the number of columns of the matrix to be cre‐
ated.
int nnz (input)
nnz specifies the number of nonzeros of the matrix to be cre‐
ated.
float *nzval (input)
nzval is an array of length nnz (or greater) that contains
the nonzero values of the matrix, packed by column.
int *rowind (input)
rowind points to the array of row indices of the nonzero val‐
ues.
int *colptr (input)
colptr is a pointer to the array of column start indices in
nzval[] and rowind[].
Stype_t stype (input)
stype specifies the storage structure of the matrix to be
created.
stype = SLU_NC
Dtype_t dtype (input)
dtype specifies the data type of the matrix to be created.
Mtype_t mtype (input)
mtype specifies the mathematical property of the matrix to be
created.
NOTES
To destroy the data structure in SuperMatrix A that was created by Cre‐
ate_CompCol_Matrix, the user may call Destroy_CompCol_Matrix() or
Destroy_SuperMatrix_Store(). The former will attempt to deallocate the
three arrays that Create_CompCol_Matrix requires on input. If this is
not desirable, the user may call Destroy_SuperMatrix_Store() which
deallocates only the data structure that Create_CompCol_Matrix itself
has allocated.
COPYRIGHT
Copyright (c) 2003, The Regents of the University of California,
through Lawrence Berkeley National Laboratory (subject to receipt of
any required approvals from U.S. Dept. of Energy)
SEE ALSO
Destroy_CompCol_Matrix
Destroy_SuperMatrix_Store
Copy_CompCol_Matrix
SuperMatrix
http://crd.lbl.gov/~xiaoye/SuperLU/
James W. Demmel, Stanley C. Eisenstat, John R. Gilbert, Xiaoye S. Li
and Joseph W. H. Liu, "A supernodal approach to sparse partial pivot‐
ing", SIAM J. Matrix Analysis and Applications, Vol. 20, Num. 3, 1999,
pp. 720-755.
6 Mar 2009 Create_CompCol_Matrix(3P)
