bundles / numpy 2.4.4 / numpy / random / _generator / Generator / shuffle
cython_function_or_method
numpy.random._generator:Generator.shuffle
Signature
def shuffle(x, axis = 0)Summary
Modify an array or sequence in-place by shuffling its contents.
Extended Summary
The order of sub-arrays is changed but their contents remains the same.
Parameters
x: ndarray or MutableSequenceThe array, list or mutable sequence to be shuffled.
axis: int, optionalThe axis which
xis shuffled along. Default is 0. It is only supported on ndarray objects.
Returns
: None
Notes
An important distinction between methods shuffle and permuted is how they both treat the axis parameter which can be found at generator-handling-axis-parameter.
Examples
rng = np.random.default_rng() arr = np.arange(10) arr rng.shuffle(arr)✓
arr
✗array([5, 6, 9, 7, 8, 1, 0, 3, 2, 4])
arr = np.arange(9).reshape((3, 3)) arr rng.shuffle(arr)✓
arr
✗array([[6, 7, 8],
[0, 1, 2],
[3, 4, 5]])
arr = np.arange(9).reshape((3, 3)) arr rng.shuffle(arr, axis=1)✓
arr
✗array([[0, 1, 2],
[3, 4, 5],
[6, 7, 8]])
See also
Aliases
numpy.random.Generator.shuffle