Ctrl+K

shuffle

Contents

shuffle#

class braincore.random.shuffle(x, axis=0, key=None)[source]#

Modify 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:

  • x (ndarray or MutableSequence) – The array, list or mutable sequence to be shuffled.

  • key (PRNGKey, optional) – The key for the random number generator. If not given, the default random number generator is used.

Return type:

None

Examples

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

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

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