summaryrefslogtreecommitdiff
path: root/numpy/linalg/info.py
diff options
context:
space:
mode:
authorJarrod Millman <millman@berkeley.edu>2007-12-29 00:30:47 +0000
committerJarrod Millman <millman@berkeley.edu>2007-12-29 00:30:47 +0000
commite31192fd7799a6456459d0e6142ddef8d46b8d08 (patch)
treee2c3383b649bc992f8fb8c81d1ae74bcef0c087c /numpy/linalg/info.py
parent15437fc1140e83d0c6dde31af9b38813cc514c2e (diff)
downloadnumpy-e31192fd7799a6456459d0e6142ddef8d46b8d08.tar.gz
docstring improvements from Pauli Virtanen
Diffstat (limited to 'numpy/linalg/info.py')
-rw-r--r--numpy/linalg/info.py39
1 files changed, 24 insertions, 15 deletions
diff --git a/numpy/linalg/info.py b/numpy/linalg/info.py
index fce02b836..f0944edea 100644
--- a/numpy/linalg/info.py
+++ b/numpy/linalg/info.py
@@ -1,24 +1,33 @@
"""\
Core Linear Algebra Tools
-===========
+-------------------------
+Linear algebra basics:
- Linear Algebra Basics:
+- norm Vector or matrix norm
+- inv Inverse of a square matrix
+- solve Solve a linear system of equations
+- det Determinant of a square matrix
+- lstsq Solve linear least-squares problem
+- pinv Pseudo-inverse (Moore-Penrose) using lstsq
- norm --- Vector or matrix norm
- inv --- Inverse of a square matrix
- solve --- Solve a linear system of equations
- det --- Determinant of a square matrix
- lstsq --- Solve linear least-squares problem
- pinv --- Pseudo-inverse (Moore-Penrose) using lstsq
+Eigenvalues and decompositions:
- Eigenvalues and Decompositions:
+- eig Eigenvalues and vectors of a square matrix
+- eigh Eigenvalues and eigenvectors of a Hermitian matrix
+- eigvals Eigenvalues of a square matrix
+- eigvalsh Eigenvalues of a Hermitian matrix
+- qr QR decomposition of a matrix
+- svd Singular value decomposition of a matrix
+- cholesky Cholesky decomposition of a matrix
- eig --- Eigenvalues and vectors of a square matrix
- eigh --- Eigenvalues and eigenvectors of a Hermitian matrix
- eigvals --- Eigenvalues of a square matrix
- eigvalsh --- Eigenvalues of a Hermitian matrix.
- svd --- Singular value decomposition of a matrix
- cholesky --- Cholesky decomposition of a matrix
+Tensor operations:
+
+- tensorsolve Solve a linear tensor equation
+- tensorinv Calculate an inverse of a tensor
+
+Exceptions:
+
+- LinAlgError Indicates a failed linear algebra operation
"""