diff options
author | alex <argriffi@ncsu.edu> | 2014-07-31 19:18:27 -0400 |
---|---|---|
committer | alex <argriffi@ncsu.edu> | 2014-07-31 19:18:27 -0400 |
commit | 3b40702dcbf89b3a312133c5cee39360b6e043ec (patch) | |
tree | 4bd265c7d644c70542c91500021703cfa7c98dd6 /numpy/matrixlib/defmatrix.py | |
parent | ae7c942ced535fb39384aefeb8d32df92fb15988 (diff) | |
download | numpy-3b40702dcbf89b3a312133c5cee39360b6e043ec.tar.gz |
DOC: add minimal clarification to the matrix.ravel docstring
Diffstat (limited to 'numpy/matrixlib/defmatrix.py')
-rw-r--r-- | numpy/matrixlib/defmatrix.py | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/numpy/matrixlib/defmatrix.py b/numpy/matrixlib/defmatrix.py index 0fd5db66a..66156a4b6 100644 --- a/numpy/matrixlib/defmatrix.py +++ b/numpy/matrixlib/defmatrix.py @@ -925,6 +925,27 @@ class matrix(N.ndarray): """ return self.__array__().ravel() + + def ravel(self): + """ + Return a flattened array. + + Refer to `numpy.ravel` for full documentation. + + See Also + -------- + numpy.ravel : equivalent function + + ndarray.flat : a flat iterator on the array. + + Notes + ----- + This returns a matrix. + + """ + return np.core.multiarray.ndarray.ravel(self) + + def getT(self): """ Returns the transpose of the matrix. |