__init__.py 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. """
  2. ==================================================
  3. Sparse linear algebra (:mod:`scipy.sparse.linalg`)
  4. ==================================================
  5. .. currentmodule:: scipy.sparse.linalg
  6. Abstract linear operators
  7. -------------------------
  8. .. autosummary::
  9. :toctree: generated/
  10. LinearOperator -- abstract representation of a linear operator
  11. aslinearoperator -- convert an object to an abstract linear operator
  12. Matrix Operations
  13. -----------------
  14. .. autosummary::
  15. :toctree: generated/
  16. inv -- compute the sparse matrix inverse
  17. expm -- compute the sparse matrix exponential
  18. expm_multiply -- compute the product of a matrix exponential and a matrix
  19. Matrix norms
  20. ------------
  21. .. autosummary::
  22. :toctree: generated/
  23. norm -- Norm of a sparse matrix
  24. onenormest -- Estimate the 1-norm of a sparse matrix
  25. Solving linear problems
  26. -----------------------
  27. Direct methods for linear equation systems:
  28. .. autosummary::
  29. :toctree: generated/
  30. spsolve -- Solve the sparse linear system Ax=b
  31. spsolve_triangular -- Solve the sparse linear system Ax=b for a triangular matrix
  32. factorized -- Pre-factorize matrix to a function solving a linear system
  33. MatrixRankWarning -- Warning on exactly singular matrices
  34. use_solver -- Select direct solver to use
  35. Iterative methods for linear equation systems:
  36. .. autosummary::
  37. :toctree: generated/
  38. bicg -- Use BIConjugate Gradient iteration to solve A x = b
  39. bicgstab -- Use BIConjugate Gradient STABilized iteration to solve A x = b
  40. cg -- Use Conjugate Gradient iteration to solve A x = b
  41. cgs -- Use Conjugate Gradient Squared iteration to solve A x = b
  42. gmres -- Use Generalized Minimal RESidual iteration to solve A x = b
  43. lgmres -- Solve a matrix equation using the LGMRES algorithm
  44. minres -- Use MINimum RESidual iteration to solve Ax = b
  45. qmr -- Use Quasi-Minimal Residual iteration to solve A x = b
  46. gcrotmk -- Solve a matrix equation using the GCROT(m,k) algorithm
  47. Iterative methods for least-squares problems:
  48. .. autosummary::
  49. :toctree: generated/
  50. lsqr -- Find the least-squares solution to a sparse linear equation system
  51. lsmr -- Find the least-squares solution to a sparse linear equation system
  52. Matrix factorizations
  53. ---------------------
  54. Eigenvalue problems:
  55. .. autosummary::
  56. :toctree: generated/
  57. eigs -- Find k eigenvalues and eigenvectors of the square matrix A
  58. eigsh -- Find k eigenvalues and eigenvectors of a symmetric matrix
  59. lobpcg -- Solve symmetric partial eigenproblems with optional preconditioning
  60. Singular values problems:
  61. .. autosummary::
  62. :toctree: generated/
  63. svds -- Compute k singular values/vectors for a sparse matrix
  64. Complete or incomplete LU factorizations
  65. .. autosummary::
  66. :toctree: generated/
  67. splu -- Compute a LU decomposition for a sparse matrix
  68. spilu -- Compute an incomplete LU decomposition for a sparse matrix
  69. SuperLU -- Object representing an LU factorization
  70. Exceptions
  71. ----------
  72. .. autosummary::
  73. :toctree: generated/
  74. ArpackNoConvergence
  75. ArpackError
  76. """
  77. from __future__ import division, print_function, absolute_import
  78. from .isolve import *
  79. from .dsolve import *
  80. from .interface import *
  81. from .eigen import *
  82. from .matfuncs import *
  83. from ._onenormest import *
  84. from ._norm import *
  85. from ._expm_multiply import *
  86. __all__ = [s for s in dir() if not s.startswith('_')]
  87. from scipy._lib._testutils import PytestTester
  88. test = PytestTester(__name__)
  89. del PytestTester