Scikit-Sparse User Guide

Scikit-sparse is a collection of sparse matrix algorithms and convenience functions built to work with SciPySparse arrays. It is largely an interface to the parts of the SuiteSparse library by Timothy A. Davis that have a GPL license and are not suitable for inclusion in SciPy proper.

Subpackages and User Guides

Scikit-sparse is organized into submodules corresponding to the submodules of SuiteSparse. These are summarized in the following table:

Subpackage	Description and User Guide
amd	Approximate Minimum Degree (AMD) Ordering (sksparse.amd)
btf	Block Triangular Form (BTF) (sksparse.btf)
camd	Constrained Approximate Minimum Degree (CAMD) Ordering (sksparse.camd)
ccolamd	Constrained Column Approximate Minimum Degree (CCOLAMD) Ordering (sksparse.ccolamd)
cholmod	Cholesky Decomposition (sksparse.cholmod)
colamd	Column Approximate Minimum Degree (COLAMD) Ordering (sksparse.colamd)
klu	Clark Kent LU Decomposition (sksparse.klu)
spqr	Sparse QR Decomposition (sksparse.spqr)
umfpack	Unsymmetric Multifrontal LU Decomposition (sksparse.umfpack)