umf_factor¶

sksparse.umfpack.umf_factor(A, *, control=None, **kwargs)[source]¶

Compute the LU factorization of a sparse matrix using UMFPACK.

This is a convenience function that creates a UMFFactor object, computes the numeric factorization, and returns the resulting object.

Parameters:

A ((M, N) numpy.ndarray or sparse array) – The input matrix to factorize.
control (UMFControl, optional) – The control parameters to use for the factorization. If not provided, default parameters are used.
kwargs (keyword arguments, optional) – Additional keyword arguments to pass to UMFControl if control is not provided.

Returns:

UMFFactor – The LU factorization of the input matrix.

Raises:

UMFPACKSingularMatrixWarning – If the matrix is exactly singular.