Sparse Linear Algebra#

Overview#

The sparse linear algebra module nvmath.sparse in nvmath-python leverages various NVIDIA math libraries to support sparse [1] linear algebra computations. As of the current Beta release, we offer the specialized sparse direct solver API based on the cuDSS library.

API Reference#

Generic Linear Algebra APIs (`nvmath.sparse`)#

Generic APIs will be available in a later release.

Specialized Linear Algebra APIs (`nvmath.sparse.advanced`)#

`direct_solver`(a, b, /, *[, options, ...])	Solve \(a @ x = b\) for \(x\).
`DirectSolver`(a, b, *[, options, execution, ...])	Create a stateful object that encapsulates the specified sparse direct solver computations and required resources.
`DirectSolverFactorizationConfig`(solver)	An interface to configure `nvmath.sparse.advanced.DirectSolver.factorize()`.
`DirectSolverFactorizationInfo`(solver)	An interface to query information returned by `nvmath.sparse.advanced.DirectSolver.factorize()`.
`DirectSolverPlanConfig`(solver)	An interface to configure `nvmath.sparse.advanced.DirectSolver.plan()`.
`DirectSolverPlanInfo`(solver)	An interface to query information returned by `nvmath.sparse.advanced.DirectSolver.plan()`.
`DirectSolverSolutionConfig`(solver)	An interface to configure `nvmath.sparse.advanced.DirectSolver.solve()`.
`memory_estimates_dtype`	NumPy dtype object that encapsulates the memory estimates in sparse.advanced.
`DirectSolverAlgType`	alias of `AlgType`
`DirectSolverMatrixType`	alias of `MatrixType`
`DirectSolverMatrixViewType`	alias of `MatrixViewType`
`DirectSolverOptions`([sparse_system_type, ...])	A data class for providing options to the `DirectSolver` object and the wrapper function `direct_solver()`.
`ExecutionCUDA`(device_id, ...)	A data class for providing GPU execution options to the `DirectSolver` object and the wrapper function `direct_solver()`.
`ExecutionHybrid`([device_id, num_threads])	A data class for providing hybrid (CPU-GPU) execution options to the `DirectSolver` object and the wrapper function `direct_solver()`.
`HybridMemoryModeOptions`([...])	A data class for providing options related to the use of hybrid (CPU-GPU) memory to those execution spaces that support it.

Footnotes