Column Approximate Minimum Degree (COLAMD) Ordering (sksparse.colamd)

Added in version 0.5.0.

Python interface to the Column Approximate Minimum Degree (COLAMD) ordering algorithm.

Interface

colamd(A[, dense_row_thresh, ...])

Compute the column approximate minimum degree ordering of a sparse matrix.

symamd(A[, dense_row_thresh, ...])

Compute the column approximate minimum degree ordering of a sparse symmetric matrix.

colamd_get_defaults()

Get the default knobs for COLAMD.

Exceptions and Warnings

COLAMDError

Base class for COLAMD errors.

COLAMDValueError

Raised when COLAMD encounters a value error.

COLAMDMemoryError

Raised when COLAMD runs out of memory.

COLAMDInternalError

Raised when COLAMD encounters an internal error.

COLAMDStats(N_rows_ignored, N_cols_ignored, ...)

Information statistics returned by the COLAMD algorithm.

References

  • SuiteSparse homepage

  • SuiteSparse COLAMD

  • COLAMD Algorithm Publications:

    • T. A. Davis, J. R. Gilbert, S. Larimore, E. Ng, An approximate column minimum degree ordering algorithm, ACM Transactions on Mathematical Software, vol. 30, no. 3., pp. 353-376, 2004.

    • T. A. Davis, J. R. Gilbert, S. Larimore, E. Ng, Algorithm 836: COLAMD, an approximate column minimum degree ordering algorithm, ACM Transactions on Mathematical Software, vol. 30, no. 3., pp. 377-380, 2004.