nlcpy.random.RandomState.shuffle

RandomState.shuffle(self, x)

Modifies a sequence in-place by shuffling its contents.

This function only shuffles the array along the first axis of a multi-dimensional array. The order of sub-arrays is changed but their contents remains the same.

Parameters

xarray_like

The array or list to be shuffled.

Returns

None

Examples

>>> import nlcpy as vp
>>> arr = vp.arange(10)
>>> vp.random.shuffle(arr)
>>> arr            
array([7, 1, 5, 6, 0, 8, 4, 2, 9, 3]) # random

Multi-dimensional arrays are only shuffled along the first axis:

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