Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/scipy/sparse/linalg/__init__.py: 100%

1""" 

2Sparse linear algebra (:mod:`scipy.sparse.linalg`) 

3================================================== 

4 

5.. currentmodule:: scipy.sparse.linalg 

6 

7Abstract linear operators 

8------------------------- 

9 

10.. autosummary:: 

11 :toctree: generated/ 

12 

13 LinearOperator -- abstract representation of a linear operator 

14 aslinearoperator -- convert an object to an abstract linear operator 

15 

16Matrix Operations 

17----------------- 

18 

19.. autosummary:: 

20 :toctree: generated/ 

21 

22 inv -- compute the sparse matrix inverse 

23 expm -- compute the sparse matrix exponential 

24 expm_multiply -- compute the product of a matrix exponential and a matrix 

25 

26Matrix norms 

27------------ 

28 

29.. autosummary:: 

30 :toctree: generated/ 

31 

32 norm -- Norm of a sparse matrix 

33 onenormest -- Estimate the 1-norm of a sparse matrix 

34 

35Solving linear problems 

36----------------------- 

37 

38Direct methods for linear equation systems: 

39 

40.. autosummary:: 

41 :toctree: generated/ 

42 

43 spsolve -- Solve the sparse linear system Ax=b 

44 spsolve_triangular -- Solve the sparse linear system Ax=b for a triangular matrix 

45 factorized -- Pre-factorize matrix to a function solving a linear system 

46 MatrixRankWarning -- Warning on exactly singular matrices 

47 use_solver -- Select direct solver to use 

48 

49Iterative methods for linear equation systems: 

50 

51.. autosummary:: 

52 :toctree: generated/ 

53 

54 bicg -- Use BIConjugate Gradient iteration to solve A x = b 

55 bicgstab -- Use BIConjugate Gradient STABilized iteration to solve A x = b 

56 cg -- Use Conjugate Gradient iteration to solve A x = b 

57 cgs -- Use Conjugate Gradient Squared iteration to solve A x = b 

58 gmres -- Use Generalized Minimal RESidual iteration to solve A x = b 

59 lgmres -- Solve a matrix equation using the LGMRES algorithm 

60 minres -- Use MINimum RESidual iteration to solve Ax = b 

61 qmr -- Use Quasi-Minimal Residual iteration to solve A x = b 

62 gcrotmk -- Solve a matrix equation using the GCROT(m,k) algorithm 

63 tfqmr -- Use Transpose-Free Quasi-Minimal Residual iteration to solve A x = b 

64 

65Iterative methods for least-squares problems: 

66 

67.. autosummary:: 

68 :toctree: generated/ 

69 

70 lsqr -- Find the least-squares solution to a sparse linear equation system 

71 lsmr -- Find the least-squares solution to a sparse linear equation system 

72 

73Matrix factorizations 

74--------------------- 

75 

76Eigenvalue problems: 

77 

78.. autosummary:: 

79 :toctree: generated/ 

80 

81 eigs -- Find k eigenvalues and eigenvectors of the square matrix A 

82 eigsh -- Find k eigenvalues and eigenvectors of a symmetric matrix 

83 lobpcg -- Solve symmetric partial eigenproblems with optional preconditioning 

84 

85Singular values problems: 

86 

87.. autosummary:: 

88 :toctree: generated/ 

89 

90 svds -- Compute k singular values/vectors for a sparse matrix 

91 

92The `svds` function supports the following solvers: 

93 

94.. toctree:: 

95 

96 sparse.linalg.svds-arpack 

97 sparse.linalg.svds-lobpcg 

98 sparse.linalg.svds-propack 

99 

100Complete or incomplete LU factorizations 

101 

102.. autosummary:: 

103 :toctree: generated/ 

104 

105 splu -- Compute a LU decomposition for a sparse matrix 

106 spilu -- Compute an incomplete LU decomposition for a sparse matrix 

107 SuperLU -- Object representing an LU factorization 

108 

109Exceptions 

110---------- 

111 

112.. autosummary:: 

113 :toctree: generated/ 

114 

115 ArpackNoConvergence 

116 ArpackError 

117 

118""" 

119 

120from ._isolve import * 

121from ._dsolve import * 

122from ._interface import * 

123from ._eigen import * 

124from ._matfuncs import * 

125from ._onenormest import * 

126from ._norm import * 

127from ._expm_multiply import * 

128 

129# Deprecated namespaces, to be removed in v2.0.0 

130from . import isolve, dsolve, interface, eigen, matfuncs 

131 

132__all__ = [s for s in dir() if not s.startswith('_')] 

133 

134from scipy._lib._testutils import PytestTester 

135test = PytestTester(__name__) 

136del PytestTester