roll¶
- roll(x: array, /, shift: int | Tuple[int, ...], *, axis: int | Tuple[int, ...] | None = None) array ¶
Rolls array elements along a specified axis. Array elements that roll beyond the last position are re-introduced at the first position. Array elements that roll beyond the first position are re-introduced at the last position.
- Parameters:
x (array) – input array.
shift (Union[int, Tuple[int, ...]]) – number of places by which the elements are shifted. If
shift
is a tuple, thenaxis
must be a tuple of the same size, and each of the given axes must be shifted by the corresponding element inshift
. Ifshift
is anint
andaxis
a tuple, then the sameshift
must be used for all specified axes. If a shift is positive, then array elements must be shifted positively (toward larger indices) along the dimension ofaxis
. If a shift is negative, then array elements must be shifted negatively (toward smaller indices) along the dimension ofaxis
.axis (Optional[Union[int, Tuple[int, ...]]]) – axis (or axes) along which elements to shift. If
axis
isNone
, the array must be flattened, shifted, and then restored to its original shape. Default:None
.
- Returns:
out (array) – an output array having the same data type as
x
and whose elements, relative tox
, are shifted.