summaryrefslogtreecommitdiff
path: root/numpy/core/defmatrix.py
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2007-05-13 00:35:09 +0000
committerCharles Harris <charlesr.harris@gmail.com>2007-05-13 00:35:09 +0000
commitbae04d1cd9af556303091bc34d20a6d72e5d7aae (patch)
treea2ad6a5a6696f3a13f6e974e2768b57d64d41deb /numpy/core/defmatrix.py
parenta7219199b9d566860b3653f60e87adc7006bb531 (diff)
downloadnumpy-bae04d1cd9af556303091bc34d20a6d72e5d7aae.tar.gz
Add documentation for diagonal.
Reformat documentation of sort, argsort, lexsort, and searchsorted.
Diffstat (limited to 'numpy/core/defmatrix.py')
-rw-r--r--numpy/core/defmatrix.py16
1 files changed, 16 insertions, 0 deletions
diff --git a/numpy/core/defmatrix.py b/numpy/core/defmatrix.py
index 1550d2444..659157d20 100644
--- a/numpy/core/defmatrix.py
+++ b/numpy/core/defmatrix.py
@@ -247,29 +247,35 @@ class matrix(N.ndarray):
the flattened array by default, otherwise over the specified axis.
:Parameters:
+
axis : integer
Axis along which the means are computed. The default is
to compute the standard deviation of the flattened array.
+
dtype : type
Type to use in computing the means. For arrays of integer type
the default is float32, for arrays of float types it is the
same as the array type.
+
out : ndarray
Alternative output array in which to place the result. It must
have the same shape as the expected output but the type will be
cast if necessary.
:Returns:
+
mean : The return type varies, see above.
A new array holding the result is returned unless out is
specified, in which case a reference to out is returned.
:SeeAlso:
+
- var : variance
- std : standard deviation
Notes
-----
+
The mean is the sum of the elements along the axis divided by the
number of elements.
@@ -284,25 +290,30 @@ class matrix(N.ndarray):
flattened array by default, otherwise over the specified axis.
:Parameters:
+
axis : integer
Axis along which the standard deviation is computed. The
default is to compute the standard deviation of the flattened
array.
+
dtype : type
Type to use in computing the standard deviation. For arrays of
integer type the default is float32, for arrays of float types
it is the same as the array type.
+
out : ndarray
Alternative output array in which to place the result. It must
have the same shape as the expected output but the type will be
cast if necessary.
:Returns:
+
standard deviation : The return type varies, see above.
A new array holding the result is returned unless out is
specified, in which case a reference to out is returned.
:SeeAlso:
+
- var : variance
- mean : average
@@ -326,24 +337,29 @@ class matrix(N.ndarray):
default, otherwise over the specified axis.
:Parameters:
+
axis : integer
Axis along which the variance is computed. The default is to
compute the variance of the flattened array.
+
dtype : type
Type to use in computing the variance. For arrays of integer
type the default is float32, for arrays of float types it is
the same as the array type.
+
out : ndarray
Alternative output array in which to place the result. It must
have the same shape as the expected output but the type will be
cast if necessary.
:Returns:
+
variance : depends, see above
A new array holding the result is returned unless out is
specified, in which case a reference to out is returned.
:SeeAlso:
+
- std : standard deviation
- mean : average