cupy.roll#

cupy.roll(a, shift, axis=None)[source]#

Roll array elements along a given axis.

Elements that roll beyond the last position are re-introduced at the first.

Parameters
  • a (ndarray) – Array to be rolled.

  • shift (int or tuple of int) – The number of places by which elements are shifted. If a tuple, then axis must be a tuple of the same size, and each of the given axes is shifted by the corresponding number. If an int while axis is a tuple of ints, then the same value is used for all given axes.

  • axis (int or tuple of int or None) – The axis along which elements are shifted. By default, the array is flattened before shifting, after which the original shape is restored.

Returns

Output array.

Return type

ndarray

See also

numpy.roll()