summaryrefslogtreecommitdiff
path: root/numpy/linalg/__init__.py
diff options
context:
space:
mode:
authorStefan van der Walt <stefan@sun.ac.za>2008-08-05 09:20:07 +0000
committerStefan van der Walt <stefan@sun.ac.za>2008-08-05 09:20:07 +0000
commit6647bf7eaeb915e2d09db8b5c7584ee286962d3b (patch)
tree803c7d548fb8dc8f571aad76c6473f20ba71c01d /numpy/linalg/__init__.py
parentf8f44a0595da3ae8be9458ead1366bcc72cd3390 (diff)
downloadnumpy-6647bf7eaeb915e2d09db8b5c7584ee286962d3b.tar.gz
Merge from documentation editor.
Diffstat (limited to 'numpy/linalg/__init__.py')
-rw-r--r--numpy/linalg/__init__.py43
1 files changed, 43 insertions, 0 deletions
diff --git a/numpy/linalg/__init__.py b/numpy/linalg/__init__.py
index 835fb74a6..58b012f00 100644
--- a/numpy/linalg/__init__.py
+++ b/numpy/linalg/__init__.py
@@ -1,3 +1,46 @@
+"""
+Core Linear Algebra Tools
+=========================
+
+=============== ==========================================================
+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) calculated using a singular
+ value decomposition
+matrix_power Integer power of a square matrix
+=============== ==========================================================
+
+=============== ==========================================================
+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
+=============== ==========================================================
+
+=============== ==========================================================
+Tensor operations
+==========================================================================
+tensorsolve Solve a linear tensor equation
+tensorinv Calculate an inverse of a tensor
+=============== ==========================================================
+
+=============== ==========================================================
+Exceptions
+==========================================================================
+LinAlgError Indicates a failed linear algebra operation
+=============== ==========================================================
+
+"""
# To get sub-modules
from info import __doc__