This is documentation for an old release of NumPy (version 1.19). Read this page Search for this page in the documentation of the latest stable release (version 2.2).

numpy.random.Generator.shuffle

method

Generator.shuffle(x, axis=0)

Modify a sequence in-place by shuffling its contents.

The order of sub-arrays is changed but their contents remains the same.

Parameters

xarray_like

The array or list to be shuffled.

axisint, optional

The axis which x is shuffled along. Default is 0. It is only supported on ndarray objects.

Returns

None

Examples

>>>

>>> rng = np.random.default_rng()
>>> arr = np.arange(10)
>>> rng.shuffle(arr)
>>> arr
[1 7 5 2 9 4 3 6 0 8] # random

>>>

>>> arr = np.arange(9).reshape((3, 3))
>>> rng.shuffle(arr)
>>> arr
array([[3, 4, 5], # random
       [6, 7, 8],
       [0, 1, 2]])

>>>

>>> arr = np.arange(9).reshape((3, 3))
>>> rng.shuffle(arr, axis=1)
>>> arr
array([[2, 0, 1], # random
       [5, 3, 4],
       [8, 6, 7]])