diff options
| author | Jarrod Millman <millman@berkeley.edu> | 2010-02-17 23:42:42 +0000 |
|---|---|---|
| committer | Jarrod Millman <millman@berkeley.edu> | 2010-02-17 23:42:42 +0000 |
| commit | dcc721a5bddde3afd4ce47d7a7b76ec6c7102b92 (patch) | |
| tree | dfb944339fc1bb15294efc2c903500ac66450c8c /numpy/core/fromnumeric.py | |
| parent | d9e1ff3f202f2c80d0a7816935c73fec57734aff (diff) | |
| download | numpy-dcc721a5bddde3afd4ce47d7a7b76ec6c7102b92.tar.gz | |
updated docstrings from pydoc website (thanks to everyone who contributed!)
Diffstat (limited to 'numpy/core/fromnumeric.py')
| -rw-r--r-- | numpy/core/fromnumeric.py | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index b9265216f..b255e89af 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -127,10 +127,28 @@ def reshape(a, newshape, order='C'): This will be a new view object if possible; otherwise, it will be a copy. + See Also -------- ndarray.reshape : Equivalent method. + Notes + ----- + + It is not always possible to change the shape of an array without + copying the data. If you want an error to be raise if the data is copied, + you should assign the new shape to the shape attribute of the array:: + + >>> a = np.zeros((10, 2)) + # A transpose make the array non-contiguous + >>> b = a.T + # Taking a view makes it possible to modify the shape without modiying the + # initial object. + >>> c = b.view() + >>> c.shape = (20) + AttributeError: incompatible shape for a non-contiguous array + + Examples -------- >>> a = np.array([[1,2,3], [4,5,6]]) @@ -1708,7 +1726,7 @@ def ptp(a, axis=None, out=None): def amax(a, axis=None, out=None): """ - Return the maximum along an axis. + Return the maximum of an array or maximum along an axis. Parameters ---------- @@ -1724,8 +1742,7 @@ def amax(a, axis=None, out=None): Returns ------- amax : ndarray - A new array or a scalar with the result, or a reference to `out` - if it was specified. + A new array or a scalar array with the result. See Also -------- @@ -1769,7 +1786,7 @@ def amax(a, axis=None, out=None): def amin(a, axis=None, out=None): """ - Return the minimum along an axis. + Return the minimum of an array or minimum along an axis. Parameters ---------- @@ -1785,8 +1802,7 @@ def amin(a, axis=None, out=None): Returns ------- amin : ndarray - A new array or a scalar with the result, or a reference to `out` if it - was specified. + A new array or a scalar array with the result. See Also -------- |