dpnp.rollaxis

dpnp.rollaxis(x, axis, start=0)[source]

Roll the specified axis backwards, until it lies in a given position.

For full documentation refer to numpy.rollaxis.

Parameters:

a ({dpnp.ndarray, usm_ndarray}) -- Input array.
axis (int) -- The axis to be rolled. The positions of the other axes do not change relative to one another.
start (int, optional) -- When start <= axis, the axis is rolled back until it lies in this position. When start > axis, the axis is rolled until it lies before this position. The default, 0, results in a "complete" roll.

Returns:

out -- An array with the same data type as x where the specified axis has been moved to the requested position.

Return type:

dpnp.ndarray

See also

dpnp.moveaxis: Move array axes to new positions.
dpnp.roll: Roll the elements of an array by a number of positions along a given axis.

Examples

>>> import dpnp as np
>>> a = np.ones((3,4,5,6))
>>> np.rollaxis(a, 3, 1).shape
(3, 6, 4, 5)
>>> np.rollaxis(a, 2).shape
(5, 3, 4, 6)
>>> np.rollaxis(a, 1, 4).shape
(3, 5, 6, 4)