axis_shuffle

pybrops.core.random.sampling.axis_shuffle(a, axis=None, rng=None)

Perform an in-place shuffle for an array along a set of axes.

Parameters:

• a (numpy.ndarray) – An array to shuffle.

• axis (Integral, Tuple[Integral,...]) – Axis or axes along which to perform an in-place shuffle.

• rng (numpy.random.Generator, numpy.random.RandomState, None) – A random number generator source. If None, then use the default global random number generator.

Return type:

None