__init__.py 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. """
  2. ``numpy.linalg``
  3. ================
  4. The NumPy linear algebra functions rely on BLAS and LAPACK to provide efficient
  5. low level implementations of standard linear algebra algorithms. Those
  6. libraries may be provided by NumPy itself using C versions of a subset of their
  7. reference implementations but, when possible, highly optimized libraries that
  8. take advantage of specialized processor functionality are preferred. Examples
  9. of such libraries are OpenBLAS, MKL (TM), and ATLAS. Because those libraries
  10. are multithreaded and processor dependent, environmental variables and external
  11. packages such as threadpoolctl may be needed to control the number of threads
  12. or specify the processor architecture.
  13. - OpenBLAS: https://www.openblas.net/
  14. - threadpoolctl: https://github.com/joblib/threadpoolctl
  15. Please note that the most-used linear algebra functions in NumPy are present in
  16. the main ``numpy`` namespace rather than in ``numpy.linalg``. There are:
  17. ``dot``, ``vdot``, ``inner``, ``outer``, ``matmul``, ``tensordot``, ``einsum``,
  18. ``einsum_path`` and ``kron``.
  19. Functions present in numpy.linalg are listed below.
  20. Matrix and vector products
  21. --------------------------
  22. multi_dot
  23. matrix_power
  24. Decompositions
  25. --------------
  26. cholesky
  27. qr
  28. svd
  29. Matrix eigenvalues
  30. ------------------
  31. eig
  32. eigh
  33. eigvals
  34. eigvalsh
  35. Norms and other numbers
  36. -----------------------
  37. norm
  38. cond
  39. det
  40. matrix_rank
  41. slogdet
  42. Solving equations and inverting matrices
  43. ----------------------------------------
  44. solve
  45. tensorsolve
  46. lstsq
  47. inv
  48. pinv
  49. tensorinv
  50. Exceptions
  51. ----------
  52. LinAlgError
  53. """
  54. # To get sub-modules
  55. from . import linalg
  56. from .linalg import *
  57. __all__ = linalg.__all__.copy()
  58. from numpy._pytesttester import PytestTester
  59. test = PytestTester(__name__)
  60. del PytestTester