diff options
| author | Eric Wieser <wieser.eric@gmail.com> | 2017-03-04 02:39:14 +0000 |
|---|---|---|
| committer | Eric Wieser <wieser.eric@gmail.com> | 2017-03-06 12:54:33 +0000 |
| commit | f2b27fb90809bdf464e66b9f3be8037e9a72c0f7 (patch) | |
| tree | 8f2edc8ae50d4342b1a16f2cf71d3547191eeee3 | |
| parent | 15325328b0cee99543ce015ad90aad7ceddca4b6 (diff) | |
| download | numpy-f2b27fb90809bdf464e66b9f3be8037e9a72c0f7.tar.gz | |
DOC: expand_dims and squeeze are inverses
[ci skip]
| -rw-r--r-- | numpy/core/fromnumeric.py | 18 | ||||
| -rw-r--r-- | numpy/lib/shape_base.py | 2 |
2 files changed, 19 insertions, 1 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index 58f8696d2..ed7c7eb93 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -1162,6 +1162,16 @@ def squeeze(a, axis=None): dimensions of length 1 removed. This is always `a` itself or a view into `a`. + Raises + ------ + ValueError + If `axis` is not `None`, and an axis being squeezed is not of length 1 + + See Also + -------- + expand_dims : The inverse operation, adding singleton dimensions + reshape : Insert, remove, and combine dimensions, and resize existing ones + Examples -------- >>> x = np.array([[[0], [1], [2]]]) @@ -1169,7 +1179,13 @@ def squeeze(a, axis=None): (1, 3, 1) >>> np.squeeze(x).shape (3,) - >>> np.squeeze(x, axis=(2,)).shape + >>> np.squeeze(x, axis=0).shape + (3, 1) + >>> np.squeeze(x, axis=1).shape + Traceback (most recent call last): + ... + ValueError: cannot select an axis to squeeze out which has size not equal to one + >>> np.squeeze(x, axis=2).shape (1, 3) """ diff --git a/numpy/lib/shape_base.py b/numpy/lib/shape_base.py index 8ebcf04b4..f78d38464 100644 --- a/numpy/lib/shape_base.py +++ b/numpy/lib/shape_base.py @@ -255,6 +255,8 @@ def expand_dims(a, axis): See Also -------- + squeeze : The inverse operation, removing singleton dimensions + reshape : Insert, remove, and combine dimensions, and resize existing ones doc.indexing, atleast_1d, atleast_2d, atleast_3d Examples |