CSPARSE
A Concise Sparse Matrix Package in C

CSPARSE is a C library which implements a number of direct methods for sparse linear systems.

The algorithms contained in CSPARSE have been chosen with five goals in mind:

1. they must embody much of the theory behind sparse matrix algorithms,
2. they must be either asymptotically optimal in their run time and memory usage or be fast in practice,
3. they must be concise so as to be easily understood and short enough to print in the book,
4. they must cover a wide spectrum of matrix operations,
5. they must be accurate and robust.

Related Data and Programs:

DLAP is a library of FORTRAN90 routines for solving sparse linear systems.

HB_IO is a library of FORTRAN90 routines for reading and writing sparse linear systems stored in the Harwell-Boeing Sparse Matrix format.

HB_TO_ST is an executable FORTRAN77 program which converts the sparse matrix information stored in a Harwell-Boeing file into a sparse triplet file.

MGMRES is a C++ routine which applies the restarted GMRES algorithm to solve a sparse linear system.

MM_IO is a library of FORTRAN90 routines for reading and writing sparse linear systems stored in the Matrix Market format.

NSPCG is a library of FORTRAN90 routines for nonsymmetric preconditioned conjugate gradient methods applied to sparse matrices.

SPARSE is a built-in MATLAB function for defining sparse matrices.

SPARSE_CC is a data directory which contains a description and examples of the CC format, ("compressed column") for storing a sparse matrix, including a way to write the matrix as a set of three files.

SPARSE_CR is a data directory which contains a description and examples of the CR format, ("compressed row") for storing a sparse matrix, including a way to write the matrix as a set of three files.

SPARSEKIT is a library of FORTRAN90 routines by Yousef Saad for sparse matrix operations.

SPARSEPAK is a library of FORTRAN90 routines that form an obsolete version of the Waterloo Sparse Matrix Package.

ST is a data directory which contains examples and an explanation of the Sparse Triplet file format for sparse matrices.

Author:

Timothy Davis

License:

CSPARSE: a Concise Sparse matrix package.
Copyright (c) 2006, Timothy A. Davis.
http://www.cise.ufl.edu/research/sparse/CSparse

CSPARSE is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

CSPARSE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this Module; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Reference:

1. Timothy Davis,
   Direct Methods for Sparse Linear Systems,
   SIAM, 2006,
   ISBN: 0898716136,
   LC: QA188.D386.

Source Code:

• csparse.c, the source code.
• csparse.h, the include file.
• csparse.csh, commands to compile the source code.

Examples and Tests:

csparse_demo1 reads an ST matrix from a file and performs basis matrix operations.

• csparse_demo1.c, the source code for the example.
• csparse_demo1.csh, commands to compile and load the source code.
• kershaw.st, an ST file containing the 4 by 4 Kershaw matrix.
• csparse_demo1.out, the printed output from running the example.

csparse_demo2 reads an ST matrix from a file and solves a linear system.

• csparse_demo2.c, the source code for the example.
• csparse_demo.c, the source code for some utility routines.
• csparse_demo2.csh, commands to compile and load the source code.
• kershaw.st, an ST file containing the 4 by 4 Kershaw matrix.
• csparse_demo2.out, the printed output from running the example.

csparse_demo3 reads an ST matrix from a file, solves a linear system, and performs and update/downdate.

• csparse_demo3.c, the source code for the example.
• csparse_demo.c, the source code for some utility routines.
• csparse_demo3.csh, commands to compile and load the source code.
• kershaw.st, an ST file containing the 4 by 4 Kershaw matrix.
• csparse_demo3.out, the printed output from running the example.

List of Routines:

• CS_ADD computes C = alpha*A + beta*B for sparse A and B;
• CS_AMD approximate minimum degree;
• CS_CHOL sparse Cholesky;
• CS_CHOLSOL x=A\b using sparse Cholesky;
• CS_COUNTS column counts for Cholesky and QR;
• CS_CUMSUM cumulative sum;
• CS_DFS depth-first-search;
• CS_DMPERM Dulmage-Mendelsohn permutation;
• CS_DROPTOL drop small entries from a sparse matrix;
• CS_DROPZEROS drop zeros from a sparse matrix;
• CS_DUPL remove (and sum) duplicates;
• CS_ENTRY add an entry to a triplet matrix;
• CS_ETREE find elimination tree;
• CS_FKEEP drop entries from a sparse matrix;
• CS_GAXPY sparse matrix times dense matrix;
• CS_HAPPLY apply Householder reflection;
• CS_HOUSE compute Householder reflection;
• CS_IPVEC x(p)=b;
• CS_LOAD load a sparse matrix from a file;
• CS_LSOLVE x=L\b;
• CS_LTSOLVE x=L'\b;
• CS_LU sparse LU factorization;
• CS_LUSOL x=A\b using sparse LU factorization;
• CS_MALLOC memory manager;
• CS_MAXTRANS maximum transveral (permutation for zero-free diagonal);
• CS_MULTIPLY sparse matrix multiply;
• CS_NORM sparse matrix norm;
• CS_PERMUTE permute a sparse matrix;
• CS_PINV invert a permutation vector;
• CS_POST postorder an elimination tree;
• CS_PRINT print a sparse matrix;
• CS_PVEC x=b(p);
• CS_QR sparse QR;
• CS_QRSOL solve a least-squares problem;
• CS_REACH find nonzero pattern of x=L\b for sparse L and b;
• CS_SCATTER scatter a sparse vector;
• CS_SCC strongly-connected components;
• CS_SCHOL symbolic Cholesky;
• CS_SPLSOLVE x=L\b where L, x, and b are all sparse;
• CS_SQR symbolic QR (also can be used for LU);
• CS_SYMPERM symmetric permutation of a sparse matrix;
• CS_TDFS depth-first-search of a tree;
• CS_TRANSPOSE transpose a sparse matrix;
• CS_TRIPLET convert a triplet form to compressed-column form;
• CS_UPDOWN sparse rank-1 Cholesky update/downdate;
• CS_USOLVE x=U\b;
• CS_UTIL various utilities (allocate/free matrices, workspace, etc);
• CS_UTSOLVE x=U'\b;

You can go up one level to the C source codes.